aad

package
v0.20240110.1151535 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/redis/2023-08-01/aad Documentation

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

Client Initialization

client := aad.NewAADClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AADClient.AccessPolicyAssignmentCreateUpdate

ctx := context.TODO()
id := aad.NewAccessPolicyAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisValue", "accessPolicyAssignmentValue")

payload := aad.RedisCacheAccessPolicyAssignment{
	// ...
}


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

Example Usage: AADClient.AccessPolicyAssignmentDelete

ctx := context.TODO()
id := aad.NewAccessPolicyAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisValue", "accessPolicyAssignmentValue")

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

Example Usage: AADClient.AccessPolicyAssignmentGet

ctx := context.TODO()
id := aad.NewAccessPolicyAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisValue", "accessPolicyAssignmentValue")

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

Example Usage: AADClient.AccessPolicyAssignmentList

ctx := context.TODO()
id := aad.NewRediID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisValue")

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

Example Usage: AADClient.AccessPolicyCreateUpdate

ctx := context.TODO()
id := aad.NewAccessPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisValue", "accessPolicyValue")

payload := aad.RedisCacheAccessPolicy{
	// ...
}


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

Example Usage: AADClient.AccessPolicyDelete

ctx := context.TODO()
id := aad.NewAccessPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisValue", "accessPolicyValue")

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

Example Usage: AADClient.AccessPolicyGet

ctx := context.TODO()
id := aad.NewAccessPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisValue", "accessPolicyValue")

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

Example Usage: AADClient.AccessPolicyList

ctx := context.TODO()
id := aad.NewRediID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisValue")

// alternatively `client.AccessPolicyList(ctx, id)` can be used to do batched pagination
items, err := client.AccessPolicyListComplete(ctx, id)
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 PossibleValuesForAccessPolicyAssignmentProvisioningState 

func PossibleValuesForAccessPolicyAssignmentProvisioningState() []string

func PossibleValuesForAccessPolicyProvisioningState 

func PossibleValuesForAccessPolicyProvisioningState() []string

func PossibleValuesForAccessPolicyType 

func PossibleValuesForAccessPolicyType() []string

func ValidateAccessPolicyAssignmentID 

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

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

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 ValidateRediID 

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

ValidateRediID checks that 'input' can be parsed as a Redi ID

Types

type AADClient 

type AADClient struct {
	Client *resourcemanager.Client
}

func NewAADClientWithBaseURI 

func NewAADClientWithBaseURI(sdkApi sdkEnv.Api) (*AADClient, error)

func (AADClient) AccessPolicyAssignmentCreateUpdate 

func (c AADClient) AccessPolicyAssignmentCreateUpdate(ctx context.Context, id AccessPolicyAssignmentId, input RedisCacheAccessPolicyAssignment) (result AccessPolicyAssignmentCreateUpdateOperationResponse, err error)

AccessPolicyAssignmentCreateUpdate ...

func (AADClient) AccessPolicyAssignmentCreateUpdateThenPoll 

func (c AADClient) AccessPolicyAssignmentCreateUpdateThenPoll(ctx context.Context, id AccessPolicyAssignmentId, input RedisCacheAccessPolicyAssignment) error

AccessPolicyAssignmentCreateUpdateThenPoll performs AccessPolicyAssignmentCreateUpdate then polls until it's completed

func (AADClient) AccessPolicyAssignmentDelete 

func (c AADClient) AccessPolicyAssignmentDelete(ctx context.Context, id AccessPolicyAssignmentId) (result AccessPolicyAssignmentDeleteOperationResponse, err error)

AccessPolicyAssignmentDelete ...

func (AADClient) AccessPolicyAssignmentDeleteThenPoll 

func (c AADClient) AccessPolicyAssignmentDeleteThenPoll(ctx context.Context, id AccessPolicyAssignmentId) error

AccessPolicyAssignmentDeleteThenPoll performs AccessPolicyAssignmentDelete then polls until it's completed

func (AADClient) AccessPolicyAssignmentGet 

func (c AADClient) AccessPolicyAssignmentGet(ctx context.Context, id AccessPolicyAssignmentId) (result AccessPolicyAssignmentGetOperationResponse, err error)

AccessPolicyAssignmentGet ...

func (AADClient) AccessPolicyAssignmentList 

func (c AADClient) AccessPolicyAssignmentList(ctx context.Context, id RediId) (result AccessPolicyAssignmentListOperationResponse, err error)

AccessPolicyAssignmentList ...

func (AADClient) AccessPolicyAssignmentListComplete 

func (c AADClient) AccessPolicyAssignmentListComplete(ctx context.Context, id RediId) (AccessPolicyAssignmentListCompleteResult, error)

AccessPolicyAssignmentListComplete retrieves all the results into a single object

func (AADClient) AccessPolicyAssignmentListCompleteMatchingPredicate 

func (c AADClient) AccessPolicyAssignmentListCompleteMatchingPredicate(ctx context.Context, id RediId, predicate RedisCacheAccessPolicyAssignmentOperationPredicate) (result AccessPolicyAssignmentListCompleteResult, err error)

AccessPolicyAssignmentListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AADClient) AccessPolicyCreateUpdate 

func (c AADClient) AccessPolicyCreateUpdate(ctx context.Context, id AccessPolicyId, input RedisCacheAccessPolicy) (result AccessPolicyCreateUpdateOperationResponse, err error)

AccessPolicyCreateUpdate ...

func (AADClient) AccessPolicyCreateUpdateThenPoll 

func (c AADClient) AccessPolicyCreateUpdateThenPoll(ctx context.Context, id AccessPolicyId, input RedisCacheAccessPolicy) error

AccessPolicyCreateUpdateThenPoll performs AccessPolicyCreateUpdate then polls until it's completed

func (AADClient) AccessPolicyDelete 

func (c AADClient) AccessPolicyDelete(ctx context.Context, id AccessPolicyId) (result AccessPolicyDeleteOperationResponse, err error)

AccessPolicyDelete ...

func (AADClient) AccessPolicyDeleteThenPoll 

func (c AADClient) AccessPolicyDeleteThenPoll(ctx context.Context, id AccessPolicyId) error

AccessPolicyDeleteThenPoll performs AccessPolicyDelete then polls until it's completed

func (AADClient) AccessPolicyGet 

func (c AADClient) AccessPolicyGet(ctx context.Context, id AccessPolicyId) (result AccessPolicyGetOperationResponse, err error)

AccessPolicyGet ...

func (AADClient) AccessPolicyList 

func (c AADClient) AccessPolicyList(ctx context.Context, id RediId) (result AccessPolicyListOperationResponse, err error)

AccessPolicyList ...

func (AADClient) AccessPolicyListComplete 

func (c AADClient) AccessPolicyListComplete(ctx context.Context, id RediId) (AccessPolicyListCompleteResult, error)

AccessPolicyListComplete retrieves all the results into a single object

func (AADClient) AccessPolicyListCompleteMatchingPredicate 

func (c AADClient) AccessPolicyListCompleteMatchingPredicate(ctx context.Context, id RediId, predicate RedisCacheAccessPolicyOperationPredicate) (result AccessPolicyListCompleteResult, err error)

AccessPolicyListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type AccessPolicyAssignmentCreateUpdateOperationResponse 

type AccessPolicyAssignmentCreateUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type AccessPolicyAssignmentDeleteOperationResponse 

type AccessPolicyAssignmentDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type AccessPolicyAssignmentGetOperationResponse 

type AccessPolicyAssignmentGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RedisCacheAccessPolicyAssignment
}

type AccessPolicyAssignmentId 

type AccessPolicyAssignmentId struct {
	SubscriptionId             string
	ResourceGroupName          string
	RedisName                  string
	AccessPolicyAssignmentName string
}

AccessPolicyAssignmentId is a struct representing the Resource ID for a Access Policy Assignment

func NewAccessPolicyAssignmentID 

func NewAccessPolicyAssignmentID(subscriptionId string, resourceGroupName string, redisName string, accessPolicyAssignmentName string) AccessPolicyAssignmentId

NewAccessPolicyAssignmentID returns a new AccessPolicyAssignmentId struct

func ParseAccessPolicyAssignmentID 

func ParseAccessPolicyAssignmentID(input string) (*AccessPolicyAssignmentId, error)

ParseAccessPolicyAssignmentID parses 'input' into a AccessPolicyAssignmentId

func ParseAccessPolicyAssignmentIDInsensitively 

func ParseAccessPolicyAssignmentIDInsensitively(input string) (*AccessPolicyAssignmentId, error)

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

func (*AccessPolicyAssignmentId) FromParseResult added in v0.20231127.1171502 

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

func (AccessPolicyAssignmentId) ID 

func (id AccessPolicyAssignmentId) ID() string

ID returns the formatted Access Policy Assignment ID

func (AccessPolicyAssignmentId) Segments 

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

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

func (AccessPolicyAssignmentId) String 

func (id AccessPolicyAssignmentId) String() string

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

type AccessPolicyAssignmentListCompleteResult 

type AccessPolicyAssignmentListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RedisCacheAccessPolicyAssignment
}

type AccessPolicyAssignmentListOperationResponse 

type AccessPolicyAssignmentListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RedisCacheAccessPolicyAssignment
}

type AccessPolicyAssignmentProvisioningState 

type AccessPolicyAssignmentProvisioningState string
const (
	AccessPolicyAssignmentProvisioningStateCanceled  AccessPolicyAssignmentProvisioningState = "Canceled"
	AccessPolicyAssignmentProvisioningStateDeleted   AccessPolicyAssignmentProvisioningState = "Deleted"
	AccessPolicyAssignmentProvisioningStateDeleting  AccessPolicyAssignmentProvisioningState = "Deleting"
	AccessPolicyAssignmentProvisioningStateFailed    AccessPolicyAssignmentProvisioningState = "Failed"
	AccessPolicyAssignmentProvisioningStateSucceeded AccessPolicyAssignmentProvisioningState = "Succeeded"
	AccessPolicyAssignmentProvisioningStateUpdating  AccessPolicyAssignmentProvisioningState = "Updating"
)

func (*AccessPolicyAssignmentProvisioningState) UnmarshalJSON 

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

type AccessPolicyCreateUpdateOperationResponse 

type AccessPolicyCreateUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type AccessPolicyDeleteOperationResponse 

type AccessPolicyDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type AccessPolicyGetOperationResponse 

type AccessPolicyGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RedisCacheAccessPolicy
}

type AccessPolicyId 

type AccessPolicyId struct {
	SubscriptionId    string
	ResourceGroupName string
	RedisName         string
	AccessPolicyName  string
}

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

func NewAccessPolicyID 

func NewAccessPolicyID(subscriptionId string, resourceGroupName string, redisName string, accessPolicyName 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 added in v0.20231127.1171502 

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 AccessPolicyListCompleteResult 

type AccessPolicyListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RedisCacheAccessPolicy
}

type AccessPolicyListOperationResponse 

type AccessPolicyListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RedisCacheAccessPolicy
}

type AccessPolicyProvisioningState 

type AccessPolicyProvisioningState string
const (
	AccessPolicyProvisioningStateCanceled  AccessPolicyProvisioningState = "Canceled"
	AccessPolicyProvisioningStateDeleted   AccessPolicyProvisioningState = "Deleted"
	AccessPolicyProvisioningStateDeleting  AccessPolicyProvisioningState = "Deleting"
	AccessPolicyProvisioningStateFailed    AccessPolicyProvisioningState = "Failed"
	AccessPolicyProvisioningStateSucceeded AccessPolicyProvisioningState = "Succeeded"
	AccessPolicyProvisioningStateUpdating  AccessPolicyProvisioningState = "Updating"
)

func (*AccessPolicyProvisioningState) UnmarshalJSON 

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

type AccessPolicyType 

type AccessPolicyType string
const (
	AccessPolicyTypeBuiltIn AccessPolicyType = "BuiltIn"
	AccessPolicyTypeCustom  AccessPolicyType = "Custom"
)

func (*AccessPolicyType) UnmarshalJSON 

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

type RediId 

type RediId struct {
	SubscriptionId    string
	ResourceGroupName string
	RedisName         string
}

RediId is a struct representing the Resource ID for a Redi

func NewRediID 

func NewRediID(subscriptionId string, resourceGroupName string, redisName string) RediId

NewRediID returns a new RediId struct

func ParseRediID 

func ParseRediID(input string) (*RediId, error)

ParseRediID parses 'input' into a RediId

func ParseRediIDInsensitively 

func ParseRediIDInsensitively(input string) (*RediId, error)

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

func (*RediId) FromParseResult added in v0.20231127.1171502 

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

func (RediId) ID 

func (id RediId) ID() string

ID returns the formatted Redi ID

func (RediId) Segments 

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

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

func (RediId) String 

func (id RediId) String() string

String returns a human-readable description of this Redi ID

type RedisCacheAccessPolicy 

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

type RedisCacheAccessPolicyAssignment 

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

type RedisCacheAccessPolicyAssignmentOperationPredicate 

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

func (RedisCacheAccessPolicyAssignmentOperationPredicate) Matches 

func (p RedisCacheAccessPolicyAssignmentOperationPredicate) Matches(input RedisCacheAccessPolicyAssignment) bool

type RedisCacheAccessPolicyAssignmentProperties 

type RedisCacheAccessPolicyAssignmentProperties struct {
	AccessPolicyName  string                                   `json:"accessPolicyName"`
	ObjectId          string                                   `json:"objectId"`
	ObjectIdAlias     string                                   `json:"objectIdAlias"`
	ProvisioningState *AccessPolicyAssignmentProvisioningState `json:"provisioningState,omitempty"`
}

type RedisCacheAccessPolicyOperationPredicate 

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

func (RedisCacheAccessPolicyOperationPredicate) Matches 

func (p RedisCacheAccessPolicyOperationPredicate) Matches(input RedisCacheAccessPolicy) bool

type RedisCacheAccessPolicyProperties 

type RedisCacheAccessPolicyProperties struct {
	Permissions       string                         `json:"permissions"`
	ProvisioningState *AccessPolicyProvisioningState `json:"provisioningState,omitempty"`
	Type              *AccessPolicyType              `json:"type,omitempty"`
}

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.