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/authorization/2022-04-01/roledefinitions
Documentation
The roledefinitions
SDK allows for interaction with the Azure Resource Manager Service authorization
(API Version 2022-04-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/authorization/2022-04-01/roledefinitions"
Client Initialization
client := roledefinitions.NewRoleDefinitionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: RoleDefinitionsClient.CreateOrUpdate
ctx := context.TODO()
id := roledefinitions.NewScopedRoleDefinitionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleDefinitionIdValue")
payload := roledefinitions.RoleDefinition{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: RoleDefinitionsClient.Delete
ctx := context.TODO()
id := roledefinitions.NewScopedRoleDefinitionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleDefinitionIdValue")
read, err := client.Delete(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: RoleDefinitionsClient.Get
ctx := context.TODO()
id := roledefinitions.NewScopedRoleDefinitionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleDefinitionIdValue")
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: RoleDefinitionsClient.List
ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")
// alternatively `client.List(ctx, id, roledefinitions.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, roledefinitions.DefaultListOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
# Functions
No description provided by the author
No description provided by the author
NewScopedRoleDefinitionID returns a new ScopedRoleDefinitionId struct.
ParseScopedRoleDefinitionID parses 'input' into a ScopedRoleDefinitionId.
ParseScopedRoleDefinitionIDInsensitively parses 'input' case-insensitively into a ScopedRoleDefinitionId note: this method should only be used for API response data and not user input.
ValidateScopedRoleDefinitionID checks that 'input' can be parsed as a Scoped Role Definition ID.
# 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
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
ScopedRoleDefinitionId is a struct representing the Resource ID for a Scoped Role Definition.