authorizations

package
v0.20240624.1113120 Latest Latest
Warning

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

Go to latest
Published: Jun 24, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

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

The authorizations 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/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

Constants

This section is empty.

Variables

This section is empty.

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

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 {
	LatestHttpResponse *http.Response
	Items              []AuthorizationContract
}

type AuthorizationListByAuthorizationProviderOperationOptions

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

func (AuthorizationListByAuthorizationProviderOperationOptions) ToHeaders

func (AuthorizationListByAuthorizationProviderOperationOptions) ToOData

func (AuthorizationListByAuthorizationProviderOperationOptions) ToQuery

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) FromParseResult

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

func (AuthorizationProviderId) ID

ID returns the formatted Authorization Provider ID

func (AuthorizationProviderId) Segments

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

AuthorizationListByAuthorizationProvider ...

func (AuthorizationsClient) AuthorizationListByAuthorizationProviderComplete

AuthorizationListByAuthorizationProviderComplete retrieves all the results into a single object

func (AuthorizationsClient) AuthorizationListByAuthorizationProviderCompleteMatchingPredicate

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL