authorizations

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/authorizations Documentation

The authorizations SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2022-08-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/2022-08-01/authorizations"

Client Initialization

client := authorizations.NewAuthorizationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AuthorizationsClient.AuthorizationListByAuthorizationProvider

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

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

Documentation

Index

• func PossibleValuesForAuthorizationType() []string
• func PossibleValuesForOAuth2GrantType() []string
• func ValidateAuthorizationProviderID(input interface{}, key string) (warnings []string, errors []error)
• type AuthorizationContract
• type AuthorizationContractOperationPredicate
  • func (p AuthorizationContractOperationPredicate) Matches(input AuthorizationContract) bool
• type AuthorizationContractProperties
• type AuthorizationError
• type AuthorizationListByAuthorizationProviderCompleteResult
• type AuthorizationListByAuthorizationProviderOperationOptions
  • func DefaultAuthorizationListByAuthorizationProviderOperationOptions() AuthorizationListByAuthorizationProviderOperationOptions
  • func (o AuthorizationListByAuthorizationProviderOperationOptions) ToHeaders() *client.Headers
  • func (o AuthorizationListByAuthorizationProviderOperationOptions) ToOData() *odata.Query
  • func (o AuthorizationListByAuthorizationProviderOperationOptions) ToQuery() *client.QueryParams
• type AuthorizationListByAuthorizationProviderOperationResponse
• type AuthorizationProviderId
  • func NewAuthorizationProviderID(subscriptionId string, resourceGroupName string, serviceName string, ...) AuthorizationProviderId
  • func ParseAuthorizationProviderID(input string) (*AuthorizationProviderId, error)
  • func ParseAuthorizationProviderIDInsensitively(input string) (*AuthorizationProviderId, error)
  • func (id AuthorizationProviderId) ID() string
  • func (id AuthorizationProviderId) Segments() []resourceids.Segment
  • func (id AuthorizationProviderId) String() string
• type AuthorizationType
  • func (s *AuthorizationType) UnmarshalJSON(bytes []byte) error
• type AuthorizationsClient
  • func NewAuthorizationsClientWithBaseURI(sdkApi sdkEnv.Api) (*AuthorizationsClient, error)
  • func (c AuthorizationsClient) AuthorizationListByAuthorizationProvider(ctx context.Context, id AuthorizationProviderId, ...) (result AuthorizationListByAuthorizationProviderOperationResponse, err error)
  • func (c AuthorizationsClient) AuthorizationListByAuthorizationProviderComplete(ctx context.Context, id AuthorizationProviderId, ...) (AuthorizationListByAuthorizationProviderCompleteResult, error)
  • func (c AuthorizationsClient) AuthorizationListByAuthorizationProviderCompleteMatchingPredicate(ctx context.Context, id AuthorizationProviderId, ...) (result AuthorizationListByAuthorizationProviderCompleteResult, err error)
• type OAuth2GrantType
  • func (s *OAuth2GrantType) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForAuthorizationType

func PossibleValuesForAuthorizationType() []string

func PossibleValuesForOAuth2GrantType

func PossibleValuesForOAuth2GrantType() []string

func ValidateAuthorizationProviderID

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

ValidateAuthorizationProviderID checks that 'input' can be parsed as a Authorization Provider ID

Types

type AuthorizationContract

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

type AuthorizationContractOperationPredicate

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

func (AuthorizationContractOperationPredicate) Matches

func (p AuthorizationContractOperationPredicate) Matches(input AuthorizationContract) bool

type AuthorizationContractProperties

type AuthorizationContractProperties struct {
	AuthorizationType *AuthorizationType  `json:"authorizationType,omitempty"`
	Error             *AuthorizationError `json:"error,omitempty"`
	Oauth2grantType   *OAuth2GrantType    `json:"oauth2grantType,omitempty"`
	Parameters        *map[string]string  `json:"parameters,omitempty"`
	Status            *string             `json:"status,omitempty"`
}

type AuthorizationError

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

type AuthorizationListByAuthorizationProviderCompleteResult

type AuthorizationListByAuthorizationProviderCompleteResult struct {
	Items []AuthorizationContract
}

type AuthorizationListByAuthorizationProviderOperationOptions

type AuthorizationListByAuthorizationProviderOperationOptions struct {
	Filter *string
	Skip   *int64
	Top    *int64
}

func DefaultAuthorizationListByAuthorizationProviderOperationOptions

func DefaultAuthorizationListByAuthorizationProviderOperationOptions() AuthorizationListByAuthorizationProviderOperationOptions

func (AuthorizationListByAuthorizationProviderOperationOptions) ToHeaders

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

func (AuthorizationListByAuthorizationProviderOperationOptions) ToOData

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

func (AuthorizationListByAuthorizationProviderOperationOptions) ToQuery

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

type AuthorizationListByAuthorizationProviderOperationResponse

type AuthorizationListByAuthorizationProviderOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AuthorizationContract
}

type AuthorizationProviderId

type AuthorizationProviderId struct {
	SubscriptionId          string
	ResourceGroupName       string
	ServiceName             string
	AuthorizationProviderId string
}

AuthorizationProviderId is a struct representing the Resource ID for a Authorization Provider

func NewAuthorizationProviderID

func NewAuthorizationProviderID(subscriptionId string, resourceGroupName string, serviceName string, authorizationProviderId string) AuthorizationProviderId

NewAuthorizationProviderID returns a new AuthorizationProviderId struct

func ParseAuthorizationProviderID

func ParseAuthorizationProviderID(input string) (*AuthorizationProviderId, error)

ParseAuthorizationProviderID parses 'input' into a AuthorizationProviderId

func ParseAuthorizationProviderIDInsensitively

func ParseAuthorizationProviderIDInsensitively(input string) (*AuthorizationProviderId, error)

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

func (AuthorizationProviderId) ID

func (id AuthorizationProviderId) ID() string

ID returns the formatted Authorization Provider ID

func (AuthorizationProviderId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Authorization Provider ID

func (AuthorizationProviderId) String

func (id AuthorizationProviderId) String() string

String returns a human-readable description of this Authorization Provider ID

type AuthorizationType

type AuthorizationType string

const (
	AuthorizationTypeOAuthTwo AuthorizationType = "OAuth2"
)

func (*AuthorizationType) UnmarshalJSON

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

type AuthorizationsClient

type AuthorizationsClient struct {
	Client *resourcemanager.Client
}

func NewAuthorizationsClientWithBaseURI

func NewAuthorizationsClientWithBaseURI(sdkApi sdkEnv.Api) (*AuthorizationsClient, error)

func (AuthorizationsClient) AuthorizationListByAuthorizationProvider

func (c AuthorizationsClient) AuthorizationListByAuthorizationProvider(ctx context.Context, id AuthorizationProviderId, options AuthorizationListByAuthorizationProviderOperationOptions) (result AuthorizationListByAuthorizationProviderOperationResponse, err error)

AuthorizationListByAuthorizationProvider ...

func (AuthorizationsClient) AuthorizationListByAuthorizationProviderComplete

func (c AuthorizationsClient) AuthorizationListByAuthorizationProviderComplete(ctx context.Context, id AuthorizationProviderId, options AuthorizationListByAuthorizationProviderOperationOptions) (AuthorizationListByAuthorizationProviderCompleteResult, error)

AuthorizationListByAuthorizationProviderComplete retrieves all the results into a single object

func (AuthorizationsClient) AuthorizationListByAuthorizationProviderCompleteMatchingPredicate

func (c AuthorizationsClient) AuthorizationListByAuthorizationProviderCompleteMatchingPredicate(ctx context.Context, id AuthorizationProviderId, options AuthorizationListByAuthorizationProviderOperationOptions, predicate AuthorizationContractOperationPredicate) (result AuthorizationListByAuthorizationProviderCompleteResult, err error)

AuthorizationListByAuthorizationProviderCompleteMatchingPredicate retrieves all the results and then applies the predicate

type OAuth2GrantType

type OAuth2GrantType string

const (
	OAuth2GrantTypeAuthorizationCode OAuth2GrantType = "AuthorizationCode"
	OAuth2GrantTypeClientCredentials OAuth2GrantType = "ClientCredentials"
)

func (*OAuth2GrantType) UnmarshalJSON

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