package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev
# README
github.com/hashicorp/go-azure-sdk/resource-manager/redis/2024-03-01/aad
Documentation
The aad
SDK allows for interaction with the Azure Resource Manager Service redis
(API Version 2024-03-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/2024-03-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
}
# Functions
No description provided by the author
NewAccessPolicyAssignmentID returns a new AccessPolicyAssignmentId struct.
NewAccessPolicyID returns a new AccessPolicyId struct.
NewRediID returns a new RediId struct.
ParseAccessPolicyAssignmentID parses 'input' into a AccessPolicyAssignmentId.
ParseAccessPolicyAssignmentIDInsensitively parses 'input' case-insensitively into a AccessPolicyAssignmentId note: this method should only be used for API response data and not user input.
ParseAccessPolicyID parses 'input' into a AccessPolicyId.
ParseAccessPolicyIDInsensitively parses 'input' case-insensitively into a AccessPolicyId note: this method should only be used for API response data and not user input.
ParseRediID parses 'input' into a RediId.
ParseRediIDInsensitively parses 'input' case-insensitively into a RediId note: this method should only be used for API response data and not user input.
No description provided by the author
No description provided by the author
No description provided by the author
ValidateAccessPolicyAssignmentID checks that 'input' can be parsed as a Access Policy Assignment ID.
ValidateAccessPolicyID checks that 'input' can be parsed as a Access Policy ID.
ValidateRediID checks that 'input' can be parsed as a Redi ID.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AccessPolicyAssignmentId is a struct representing the Resource ID for a Access Policy Assignment.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AccessPolicyId is a struct representing the Resource ID for a Access Policy.
No description provided by the author
No description provided by the author
No description provided by the author
RediId is a struct representing the Resource ID for a Redi.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author