roledefinitions

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
}

Documentation

Index

• func ValidateScopedRoleDefinitionID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationOptions
  • func DefaultListOperationOptions() ListOperationOptions
  • func (o ListOperationOptions) ToHeaders() *client.Headers
  • func (o ListOperationOptions) ToOData() *odata.Query
  • func (o ListOperationOptions) ToQuery() *client.QueryParams
• type ListOperationResponse
• type Permission
• type RoleDefinition
• type RoleDefinitionOperationPredicate
  • func (p RoleDefinitionOperationPredicate) Matches(input RoleDefinition) bool
• type RoleDefinitionProperties
  • func (o *RoleDefinitionProperties) GetCreatedOnAsTime() (*time.Time, error)
  • func (o *RoleDefinitionProperties) GetUpdatedOnAsTime() (*time.Time, error)
  • func (o *RoleDefinitionProperties) SetCreatedOnAsTime(input time.Time)
  • func (o *RoleDefinitionProperties) SetUpdatedOnAsTime(input time.Time)
• type RoleDefinitionsClient
  • func NewRoleDefinitionsClientWithBaseURI(sdkApi sdkEnv.Api) (*RoleDefinitionsClient, error)
  • func (c RoleDefinitionsClient) CreateOrUpdate(ctx context.Context, id ScopedRoleDefinitionId, input RoleDefinition) (result CreateOrUpdateOperationResponse, err error)
  • func (c RoleDefinitionsClient) Delete(ctx context.Context, id ScopedRoleDefinitionId) (result DeleteOperationResponse, err error)
  • func (c RoleDefinitionsClient) Get(ctx context.Context, id ScopedRoleDefinitionId) (result GetOperationResponse, err error)
  • func (c RoleDefinitionsClient) List(ctx context.Context, id commonids.ScopeId, options ListOperationOptions) (result ListOperationResponse, err error)
  • func (c RoleDefinitionsClient) ListComplete(ctx context.Context, id commonids.ScopeId, options ListOperationOptions) (ListCompleteResult, error)
  • func (c RoleDefinitionsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options ListOperationOptions, ...) (result ListCompleteResult, err error)
• type ScopedRoleDefinitionId
  • func NewScopedRoleDefinitionID(scope string, roleDefinitionId string) ScopedRoleDefinitionId
  • func ParseScopedRoleDefinitionID(input string) (*ScopedRoleDefinitionId, error)
  • func ParseScopedRoleDefinitionIDInsensitively(input string) (*ScopedRoleDefinitionId, error)
  • func (id *ScopedRoleDefinitionId) FromParseResult(input resourceids.ParseResult) error
  • func (id ScopedRoleDefinitionId) ID() string
  • func (id ScopedRoleDefinitionId) Segments() []resourceids.Segment
  • func (id ScopedRoleDefinitionId) String() string

Functions

func ValidateScopedRoleDefinitionID

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

ValidateScopedRoleDefinitionID checks that 'input' can be parsed as a Scoped Role Definition ID

Types

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RoleDefinition
}

type ListOperationOptions

type ListOperationOptions struct {
	Filter *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders

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

func (ListOperationOptions) ToOData

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

func (ListOperationOptions) ToQuery

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

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RoleDefinition
}

type Permission

type Permission struct {
	Actions        *[]string `json:"actions,omitempty"`
	DataActions    *[]string `json:"dataActions,omitempty"`
	NotActions     *[]string `json:"notActions,omitempty"`
	NotDataActions *[]string `json:"notDataActions,omitempty"`
}

type RoleDefinition

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

type RoleDefinitionOperationPredicate

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

func (RoleDefinitionOperationPredicate) Matches

func (p RoleDefinitionOperationPredicate) Matches(input RoleDefinition) bool

type RoleDefinitionProperties

type RoleDefinitionProperties struct {
	AssignableScopes *[]string     `json:"assignableScopes,omitempty"`
	CreatedBy        *string       `json:"createdBy,omitempty"`
	CreatedOn        *string       `json:"createdOn,omitempty"`
	Description      *string       `json:"description,omitempty"`
	Permissions      *[]Permission `json:"permissions,omitempty"`
	RoleName         *string       `json:"roleName,omitempty"`
	Type             *string       `json:"type,omitempty"`
	UpdatedBy        *string       `json:"updatedBy,omitempty"`
	UpdatedOn        *string       `json:"updatedOn,omitempty"`
}

func (*RoleDefinitionProperties) GetCreatedOnAsTime

func (o *RoleDefinitionProperties) GetCreatedOnAsTime() (*time.Time, error)

func (*RoleDefinitionProperties) GetUpdatedOnAsTime

func (o *RoleDefinitionProperties) GetUpdatedOnAsTime() (*time.Time, error)

func (*RoleDefinitionProperties) SetCreatedOnAsTime

func (o *RoleDefinitionProperties) SetCreatedOnAsTime(input time.Time)

func (*RoleDefinitionProperties) SetUpdatedOnAsTime

func (o *RoleDefinitionProperties) SetUpdatedOnAsTime(input time.Time)

type RoleDefinitionsClient

type RoleDefinitionsClient struct {
	Client *resourcemanager.Client
}

func NewRoleDefinitionsClientWithBaseURI

func NewRoleDefinitionsClientWithBaseURI(sdkApi sdkEnv.Api) (*RoleDefinitionsClient, error)

func (RoleDefinitionsClient) CreateOrUpdate

func (c RoleDefinitionsClient) CreateOrUpdate(ctx context.Context, id ScopedRoleDefinitionId, input RoleDefinition) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (RoleDefinitionsClient) Delete

func (c RoleDefinitionsClient) Delete(ctx context.Context, id ScopedRoleDefinitionId) (result DeleteOperationResponse, err error)

Delete ...

func (RoleDefinitionsClient) Get

func (c RoleDefinitionsClient) Get(ctx context.Context, id ScopedRoleDefinitionId) (result GetOperationResponse, err error)

Get ...

func (RoleDefinitionsClient) List

func (c RoleDefinitionsClient) List(ctx context.Context, id commonids.ScopeId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (RoleDefinitionsClient) ListComplete

func (c RoleDefinitionsClient) ListComplete(ctx context.Context, id commonids.ScopeId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (RoleDefinitionsClient) ListCompleteMatchingPredicate

func (c RoleDefinitionsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options ListOperationOptions, predicate RoleDefinitionOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ScopedRoleDefinitionId

type ScopedRoleDefinitionId struct {
	Scope            string
	RoleDefinitionId string
}

ScopedRoleDefinitionId is a struct representing the Resource ID for a Scoped Role Definition

func NewScopedRoleDefinitionID

func NewScopedRoleDefinitionID(scope string, roleDefinitionId string) ScopedRoleDefinitionId

NewScopedRoleDefinitionID returns a new ScopedRoleDefinitionId struct

func ParseScopedRoleDefinitionID

func ParseScopedRoleDefinitionID(input string) (*ScopedRoleDefinitionId, error)

ParseScopedRoleDefinitionID parses 'input' into a ScopedRoleDefinitionId

func ParseScopedRoleDefinitionIDInsensitively

func ParseScopedRoleDefinitionIDInsensitively(input string) (*ScopedRoleDefinitionId, error)

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

func (*ScopedRoleDefinitionId) FromParseResult

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

func (ScopedRoleDefinitionId) ID

func (id ScopedRoleDefinitionId) ID() string

ID returns the formatted Scoped Role Definition ID

func (ScopedRoleDefinitionId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Scoped Role Definition ID

func (ScopedRoleDefinitionId) String

func (id ScopedRoleDefinitionId) String() string

String returns a human-readable description of this Scoped Role Definition ID