authorizationaccesspolicy

package
v0.20241009.1142232 Latest Latest
Warning

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

 Go to latest Published: Oct 9, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

README

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

The authorizationaccesspolicy 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/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", "serviceName", "authorizationProviderId", "authorizationId", "authorizationAccessPolicyId")

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", "serviceName", "authorizationProviderId", "authorizationId", "authorizationAccessPolicyId")

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", "serviceName", "authorizationProviderId", "authorizationId", "authorizationAccessPolicyId")

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", "serviceName", "authorizationProviderId", "authorizationId")

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

Constants

This section is empty.

Variables

This section is empty.

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

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

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 *resourcemanager.Client
}

func NewAuthorizationAccessPolicyClientWithBaseURI 

func NewAuthorizationAccessPolicyClientWithBaseURI(sdkApi sdkEnv.Api) (*AuthorizationAccessPolicyClient, error)

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) (result ListByAuthorizationOperationResponse, err error)

ListByAuthorization ...

func (AuthorizationAccessPolicyClient) ListByAuthorizationComplete 

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

ListByAuthorizationComplete retrieves all the results into a single object

func (AuthorizationAccessPolicyClient) ListByAuthorizationCompleteMatchingPredicate 

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

ListByAuthorizationCompleteMatchingPredicate retrieves all the results and then applies 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 {
	AppIds   *[]string `json:"appIds,omitempty"`
	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) FromParseResult 

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

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

func (CreateOrUpdateOperationOptions) ToHeaders 

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

func (CreateOrUpdateOperationOptions) ToOData 

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

func (CreateOrUpdateOperationOptions) ToQuery 

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

type CreateOrUpdateOperationResponse 

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

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders 

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

func (DeleteOperationOptions) ToOData 

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

func (DeleteOperationOptions) ToQuery 

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

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

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

type ListByAuthorizationCompleteResult 

type ListByAuthorizationCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AuthorizationAccessPolicyContract
}

type ListByAuthorizationCustomPager 

type ListByAuthorizationCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByAuthorizationCustomPager) NextPageLink() *odata.Link

type ListByAuthorizationOperationOptions 

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

func DefaultListByAuthorizationOperationOptions 

func DefaultListByAuthorizationOperationOptions() ListByAuthorizationOperationOptions

func (ListByAuthorizationOperationOptions) ToHeaders 

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

func (ListByAuthorizationOperationOptions) ToOData 

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

func (ListByAuthorizationOperationOptions) ToQuery 

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

type ListByAuthorizationOperationResponse 

type ListByAuthorizationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AuthorizationAccessPolicyContract
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.