authorizationaccesspolicy

README

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

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

Client Initialization

client := authorizationaccesspolicy.NewAuthorizationAccessPolicyClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AuthorizationAccessPolicyClient.CreateOrUpdate

ctx := context.TODO()
id := authorizationaccesspolicy.NewAccessPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "authorizationProviderIdValue", "authorizationIdValue", "authorizationAccessPolicyIdValue")

payload := authorizationaccesspolicy.AuthorizationAccessPolicyContract{
	// ...
}


read, err := client.CreateOrUpdate(ctx, id, payload, authorizationaccesspolicy.DefaultCreateOrUpdateOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AuthorizationAccessPolicyClient.Delete

ctx := context.TODO()
id := authorizationaccesspolicy.NewAccessPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "authorizationProviderIdValue", "authorizationIdValue", "authorizationAccessPolicyIdValue")

read, err := client.Delete(ctx, id, authorizationaccesspolicy.DefaultDeleteOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AuthorizationAccessPolicyClient.Get

ctx := context.TODO()
id := authorizationaccesspolicy.NewAccessPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "authorizationProviderIdValue", "authorizationIdValue", "authorizationAccessPolicyIdValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AuthorizationAccessPolicyClient.ListByAuthorization

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

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

Documentation

Index

• func ValidateAccessPolicyID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateAuthorizationID(input interface{}, key string) (warnings []string, errors []error)
• type AccessPolicyId
  • func NewAccessPolicyID(subscriptionId string, resourceGroupName string, serviceName string, ...) AccessPolicyId
  • func ParseAccessPolicyID(input string) (*AccessPolicyId, error)
  • func ParseAccessPolicyIDInsensitively(input string) (*AccessPolicyId, error)
  • func (id AccessPolicyId) ID() string
  • func (id AccessPolicyId) Segments() []resourceids.Segment
  • func (id AccessPolicyId) String() string
• type AuthorizationAccessPolicyClient
  • func NewAuthorizationAccessPolicyClientWithBaseURI(endpoint string) AuthorizationAccessPolicyClient
  • func (c AuthorizationAccessPolicyClient) CreateOrUpdate(ctx context.Context, id AccessPolicyId, ...) (result CreateOrUpdateOperationResponse, err error)
  • func (c AuthorizationAccessPolicyClient) Delete(ctx context.Context, id AccessPolicyId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
  • func (c AuthorizationAccessPolicyClient) Get(ctx context.Context, id AccessPolicyId) (result GetOperationResponse, err error)
  • func (c AuthorizationAccessPolicyClient) ListByAuthorization(ctx context.Context, id AuthorizationId, ...) (resp ListByAuthorizationOperationResponse, err error)
  • func (c AuthorizationAccessPolicyClient) ListByAuthorizationComplete(ctx context.Context, id AuthorizationId, ...) (ListByAuthorizationCompleteResult, error)
  • func (c AuthorizationAccessPolicyClient) ListByAuthorizationCompleteMatchingPredicate(ctx context.Context, id AuthorizationId, ...) (resp ListByAuthorizationCompleteResult, err error)
• type AuthorizationAccessPolicyContract
• type AuthorizationAccessPolicyContractOperationPredicate
  • func (p AuthorizationAccessPolicyContractOperationPredicate) Matches(input AuthorizationAccessPolicyContract) bool
• type AuthorizationAccessPolicyContractProperties
• type AuthorizationId
  • func NewAuthorizationID(subscriptionId string, resourceGroupName string, serviceName string, ...) AuthorizationId
  • func ParseAuthorizationID(input string) (*AuthorizationId, error)
  • func ParseAuthorizationIDInsensitively(input string) (*AuthorizationId, error)
  • func (id AuthorizationId) ID() string
  • func (id AuthorizationId) Segments() []resourceids.Segment
  • func (id AuthorizationId) String() string
• type CreateOrUpdateOperationOptions
  • func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions
• type CreateOrUpdateOperationResponse
• type DeleteOperationOptions
  • func DefaultDeleteOperationOptions() DeleteOperationOptions
• type DeleteOperationResponse
• type GetOperationResponse
• type ListByAuthorizationCompleteResult
• type ListByAuthorizationOperationOptions
  • func DefaultListByAuthorizationOperationOptions() ListByAuthorizationOperationOptions
• type ListByAuthorizationOperationResponse
  • func (r ListByAuthorizationOperationResponse) HasMore() bool
  • func (r ListByAuthorizationOperationResponse) LoadMore(ctx context.Context) (resp ListByAuthorizationOperationResponse, err error)

Functions

func ValidateAccessPolicyID

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

ValidateAccessPolicyID checks that 'input' can be parsed as a Access Policy ID

func ValidateAuthorizationID

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

ValidateAuthorizationID checks that 'input' can be parsed as a Authorization ID

Types

type AccessPolicyId

type AccessPolicyId struct {
	SubscriptionId              string
	ResourceGroupName           string
	ServiceName                 string
	AuthorizationProviderId     string
	AuthorizationId             string
	AuthorizationAccessPolicyId string
}

AccessPolicyId is a struct representing the Resource ID for a Access Policy

func NewAccessPolicyID

func NewAccessPolicyID(subscriptionId string, resourceGroupName string, serviceName string, authorizationProviderId string, authorizationId string, authorizationAccessPolicyId string) AccessPolicyId

NewAccessPolicyID returns a new AccessPolicyId struct

func ParseAccessPolicyID

func ParseAccessPolicyID(input string) (*AccessPolicyId, error)

ParseAccessPolicyID parses 'input' into a AccessPolicyId

func ParseAccessPolicyIDInsensitively

func ParseAccessPolicyIDInsensitively(input string) (*AccessPolicyId, error)

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

func (AccessPolicyId) ID

func (id AccessPolicyId) ID() string

ID returns the formatted Access Policy ID

func (AccessPolicyId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Access Policy ID

func (AccessPolicyId) String

func (id AccessPolicyId) String() string

String returns a human-readable description of this Access Policy ID

type AuthorizationAccessPolicyClient

type AuthorizationAccessPolicyClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewAuthorizationAccessPolicyClientWithBaseURI

func NewAuthorizationAccessPolicyClientWithBaseURI(endpoint string) AuthorizationAccessPolicyClient

func (AuthorizationAccessPolicyClient) CreateOrUpdate

func (c AuthorizationAccessPolicyClient) CreateOrUpdate(ctx context.Context, id AccessPolicyId, input AuthorizationAccessPolicyContract, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (AuthorizationAccessPolicyClient) Delete

func (c AuthorizationAccessPolicyClient) Delete(ctx context.Context, id AccessPolicyId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (AuthorizationAccessPolicyClient) Get

func (c AuthorizationAccessPolicyClient) Get(ctx context.Context, id AccessPolicyId) (result GetOperationResponse, err error)

Get ...

func (AuthorizationAccessPolicyClient) ListByAuthorization

func (c AuthorizationAccessPolicyClient) ListByAuthorization(ctx context.Context, id AuthorizationId, options ListByAuthorizationOperationOptions) (resp ListByAuthorizationOperationResponse, err error)

ListByAuthorization ...

func (AuthorizationAccessPolicyClient) ListByAuthorizationComplete

func (c AuthorizationAccessPolicyClient) ListByAuthorizationComplete(ctx context.Context, id AuthorizationId, options ListByAuthorizationOperationOptions) (ListByAuthorizationCompleteResult, error)

ListByAuthorizationComplete retrieves all of the results into a single object

func (AuthorizationAccessPolicyClient) ListByAuthorizationCompleteMatchingPredicate

func (c AuthorizationAccessPolicyClient) ListByAuthorizationCompleteMatchingPredicate(ctx context.Context, id AuthorizationId, options ListByAuthorizationOperationOptions, predicate AuthorizationAccessPolicyContractOperationPredicate) (resp ListByAuthorizationCompleteResult, err error)

ListByAuthorizationCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type AuthorizationAccessPolicyContract

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

type AuthorizationAccessPolicyContractOperationPredicate

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

func (AuthorizationAccessPolicyContractOperationPredicate) Matches

func (p AuthorizationAccessPolicyContractOperationPredicate) Matches(input AuthorizationAccessPolicyContract) bool

type AuthorizationAccessPolicyContractProperties

type AuthorizationAccessPolicyContractProperties struct {
	ObjectId *string `json:"objectId,omitempty"`
	TenantId *string `json:"tenantId,omitempty"`
}

type AuthorizationId

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

AuthorizationId is a struct representing the Resource ID for a Authorization

func NewAuthorizationID

func NewAuthorizationID(subscriptionId string, resourceGroupName string, serviceName string, authorizationProviderId string, authorizationId string) AuthorizationId

NewAuthorizationID returns a new AuthorizationId struct

func ParseAuthorizationID

func ParseAuthorizationID(input string) (*AuthorizationId, error)

ParseAuthorizationID parses 'input' into a AuthorizationId

func ParseAuthorizationIDInsensitively

func ParseAuthorizationIDInsensitively(input string) (*AuthorizationId, error)

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

func (AuthorizationId) ID

func (id AuthorizationId) ID() string

ID returns the formatted Authorization ID

func (AuthorizationId) Segments

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

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

func (AuthorizationId) String

func (id AuthorizationId) String() string

String returns a human-readable description of this Authorization ID

type CreateOrUpdateOperationOptions

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *AuthorizationAccessPolicyContract
}

type DeleteOperationOptions

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions

func DefaultDeleteOperationOptions() DeleteOperationOptions

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *AuthorizationAccessPolicyContract
}

type ListByAuthorizationCompleteResult

type ListByAuthorizationCompleteResult struct {
	Items []AuthorizationAccessPolicyContract
}

type ListByAuthorizationOperationOptions

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

func DefaultListByAuthorizationOperationOptions

func DefaultListByAuthorizationOperationOptions() ListByAuthorizationOperationOptions

type ListByAuthorizationOperationResponse

type ListByAuthorizationOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]AuthorizationAccessPolicyContract
	// contains filtered or unexported fields
}

func (ListByAuthorizationOperationResponse) HasMore

func (r ListByAuthorizationOperationResponse) HasMore() bool

func (ListByAuthorizationOperationResponse) LoadMore

func (r ListByAuthorizationOperationResponse) LoadMore(ctx context.Context) (resp ListByAuthorizationOperationResponse, err error)