roleassignments

package
v0.20240903.1131440 Latest Latest
Warning

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

 Go to latest Published: Sep 3, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/authorization/2022-04-01/roleassignments Documentation

The roleassignments 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/roleassignments"

Client Initialization

client := roleassignments.NewRoleAssignmentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RoleAssignmentsClient.Create

ctx := context.TODO()
id := roleassignments.NewScopedRoleAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleAssignmentValue")

payload := roleassignments.RoleAssignmentCreateParameters{
	// ...
}


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

Example Usage: RoleAssignmentsClient.CreateById

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

payload := roleassignments.RoleAssignmentCreateParameters{
	// ...
}


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

Example Usage: RoleAssignmentsClient.Delete

ctx := context.TODO()
id := roleassignments.NewScopedRoleAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleAssignmentValue")

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

Example Usage: RoleAssignmentsClient.DeleteById

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: RoleAssignmentsClient.Get

ctx := context.TODO()
id := roleassignments.NewScopedRoleAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleAssignmentValue")

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

Example Usage: RoleAssignmentsClient.GetById

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: RoleAssignmentsClient.ListForResource

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: RoleAssignmentsClient.ListForResourceGroup

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

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

Example Usage: RoleAssignmentsClient.ListForScope

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: RoleAssignmentsClient.ListForSubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.ListForSubscription(ctx, id, roleassignments.DefaultListForSubscriptionOperationOptions())` can be used to do batched pagination
items, err := client.ListForSubscriptionComplete(ctx, id, roleassignments.DefaultListForSubscriptionOperationOptions())
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 PossibleValuesForPrincipalType 

func PossibleValuesForPrincipalType() []string

func ValidateScopedRoleAssignmentID 

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

ValidateScopedRoleAssignmentID checks that 'input' can be parsed as a Scoped Role Assignment ID

Types

type CreateByIdOperationResponse 

type CreateByIdOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RoleAssignment
}

type CreateOperationResponse 

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RoleAssignment
}

type DeleteByIdOperationOptions 

type DeleteByIdOperationOptions struct {
	TenantId *string
}

func DefaultDeleteByIdOperationOptions 

func DefaultDeleteByIdOperationOptions() DeleteByIdOperationOptions

func (DeleteByIdOperationOptions) ToHeaders 

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

func (DeleteByIdOperationOptions) ToOData 

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

func (DeleteByIdOperationOptions) ToQuery 

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

type DeleteByIdOperationResponse 

type DeleteByIdOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RoleAssignment
}

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	TenantId *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
	Model        *RoleAssignment
}

type GetByIdOperationOptions 

type GetByIdOperationOptions struct {
	TenantId *string
}

func DefaultGetByIdOperationOptions 

func DefaultGetByIdOperationOptions() GetByIdOperationOptions

func (GetByIdOperationOptions) ToHeaders 

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

func (GetByIdOperationOptions) ToOData 

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

func (GetByIdOperationOptions) ToQuery 

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

type GetByIdOperationResponse 

type GetByIdOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RoleAssignment
}

type GetOperationOptions 

type GetOperationOptions struct {
	TenantId *string
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders 

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

func (GetOperationOptions) ToOData 

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

func (GetOperationOptions) ToQuery 

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

type GetOperationResponse 

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

type ListForResourceCompleteResult 

type ListForResourceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RoleAssignment
}

type ListForResourceCustomPager added in v0.20240628.1153531 

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

type ListForResourceGroupCompleteResult 

type ListForResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RoleAssignment
}

type ListForResourceGroupCustomPager added in v0.20240628.1153531 

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

type ListForResourceGroupOperationOptions 

type ListForResourceGroupOperationOptions struct {
	Filter   *string
	TenantId *string
}

func DefaultListForResourceGroupOperationOptions 

func DefaultListForResourceGroupOperationOptions() ListForResourceGroupOperationOptions

func (ListForResourceGroupOperationOptions) ToHeaders 

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

func (ListForResourceGroupOperationOptions) ToOData 

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

func (ListForResourceGroupOperationOptions) ToQuery 

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

type ListForResourceGroupOperationResponse 

type ListForResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RoleAssignment
}

type ListForResourceOperationOptions 

type ListForResourceOperationOptions struct {
	Filter   *string
	TenantId *string
}

func DefaultListForResourceOperationOptions 

func DefaultListForResourceOperationOptions() ListForResourceOperationOptions

func (ListForResourceOperationOptions) ToHeaders 

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

func (ListForResourceOperationOptions) ToOData 

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

func (ListForResourceOperationOptions) ToQuery 

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

type ListForResourceOperationResponse 

type ListForResourceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RoleAssignment
}

type ListForScopeCompleteResult 

type ListForScopeCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RoleAssignment
}

type ListForScopeCustomPager added in v0.20240628.1153531 

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

type ListForScopeOperationOptions 

type ListForScopeOperationOptions struct {
	Filter   *string
	TenantId *string
}

func DefaultListForScopeOperationOptions 

func DefaultListForScopeOperationOptions() ListForScopeOperationOptions

func (ListForScopeOperationOptions) ToHeaders 

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

func (ListForScopeOperationOptions) ToOData 

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

func (ListForScopeOperationOptions) ToQuery 

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

type ListForScopeOperationResponse 

type ListForScopeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RoleAssignment
}

type ListForSubscriptionCompleteResult 

type ListForSubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RoleAssignment
}

type ListForSubscriptionCustomPager added in v0.20240628.1153531 

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

type ListForSubscriptionOperationOptions 

type ListForSubscriptionOperationOptions struct {
	Filter   *string
	TenantId *string
}

func DefaultListForSubscriptionOperationOptions 

func DefaultListForSubscriptionOperationOptions() ListForSubscriptionOperationOptions

func (ListForSubscriptionOperationOptions) ToHeaders 

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

func (ListForSubscriptionOperationOptions) ToOData 

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

func (ListForSubscriptionOperationOptions) ToQuery 

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

type ListForSubscriptionOperationResponse 

type ListForSubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RoleAssignment
}

type PrincipalType 

type PrincipalType string
const (
	PrincipalTypeDevice           PrincipalType = "Device"
	PrincipalTypeForeignGroup     PrincipalType = "ForeignGroup"
	PrincipalTypeGroup            PrincipalType = "Group"
	PrincipalTypeServicePrincipal PrincipalType = "ServicePrincipal"
	PrincipalTypeUser             PrincipalType = "User"
)

func (*PrincipalType) UnmarshalJSON 

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

type RoleAssignment 

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

type RoleAssignmentCreateParameters 

type RoleAssignmentCreateParameters struct {
	Properties RoleAssignmentProperties `json:"properties"`
}

type RoleAssignmentOperationPredicate 

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

func (RoleAssignmentOperationPredicate) Matches 

func (p RoleAssignmentOperationPredicate) Matches(input RoleAssignment) bool

type RoleAssignmentProperties 

type RoleAssignmentProperties struct {
	Condition                          *string        `json:"condition,omitempty"`
	ConditionVersion                   *string        `json:"conditionVersion,omitempty"`
	CreatedBy                          *string        `json:"createdBy,omitempty"`
	CreatedOn                          *string        `json:"createdOn,omitempty"`
	DelegatedManagedIdentityResourceId *string        `json:"delegatedManagedIdentityResourceId,omitempty"`
	Description                        *string        `json:"description,omitempty"`
	PrincipalId                        string         `json:"principalId"`
	PrincipalType                      *PrincipalType `json:"principalType,omitempty"`
	RoleDefinitionId                   string         `json:"roleDefinitionId"`
	Scope                              *string        `json:"scope,omitempty"`
	UpdatedBy                          *string        `json:"updatedBy,omitempty"`
	UpdatedOn                          *string        `json:"updatedOn,omitempty"`
}

func (*RoleAssignmentProperties) GetCreatedOnAsTime 

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

func (*RoleAssignmentProperties) GetUpdatedOnAsTime 

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

func (*RoleAssignmentProperties) SetCreatedOnAsTime 

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

func (*RoleAssignmentProperties) SetUpdatedOnAsTime 

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

type RoleAssignmentsClient 

type RoleAssignmentsClient struct {
	Client *resourcemanager.Client
}

func NewRoleAssignmentsClientWithBaseURI 

func NewRoleAssignmentsClientWithBaseURI(sdkApi sdkEnv.Api) (*RoleAssignmentsClient, error)

func (RoleAssignmentsClient) Create 

func (c RoleAssignmentsClient) Create(ctx context.Context, id ScopedRoleAssignmentId, input RoleAssignmentCreateParameters) (result CreateOperationResponse, err error)

Create ...

func (RoleAssignmentsClient) CreateById 

func (c RoleAssignmentsClient) CreateById(ctx context.Context, id commonids.ScopeId, input RoleAssignmentCreateParameters) (result CreateByIdOperationResponse, err error)

CreateById ...

func (RoleAssignmentsClient) Delete 

func (c RoleAssignmentsClient) Delete(ctx context.Context, id ScopedRoleAssignmentId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (RoleAssignmentsClient) DeleteById 

func (c RoleAssignmentsClient) DeleteById(ctx context.Context, id commonids.ScopeId, options DeleteByIdOperationOptions) (result DeleteByIdOperationResponse, err error)

DeleteById ...

func (RoleAssignmentsClient) Get 

func (c RoleAssignmentsClient) Get(ctx context.Context, id ScopedRoleAssignmentId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (RoleAssignmentsClient) GetById 

func (c RoleAssignmentsClient) GetById(ctx context.Context, id commonids.ScopeId, options GetByIdOperationOptions) (result GetByIdOperationResponse, err error)

GetById ...

func (RoleAssignmentsClient) ListForResource 

func (c RoleAssignmentsClient) ListForResource(ctx context.Context, id commonids.ScopeId, options ListForResourceOperationOptions) (result ListForResourceOperationResponse, err error)

ListForResource ...

func (RoleAssignmentsClient) ListForResourceComplete 

func (c RoleAssignmentsClient) ListForResourceComplete(ctx context.Context, id commonids.ScopeId, options ListForResourceOperationOptions) (ListForResourceCompleteResult, error)

ListForResourceComplete retrieves all the results into a single object

func (RoleAssignmentsClient) ListForResourceCompleteMatchingPredicate 

func (c RoleAssignmentsClient) ListForResourceCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options ListForResourceOperationOptions, predicate RoleAssignmentOperationPredicate) (result ListForResourceCompleteResult, err error)

ListForResourceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (RoleAssignmentsClient) ListForResourceGroup 

func (c RoleAssignmentsClient) ListForResourceGroup(ctx context.Context, id commonids.ResourceGroupId, options ListForResourceGroupOperationOptions) (result ListForResourceGroupOperationResponse, err error)

ListForResourceGroup ...

func (RoleAssignmentsClient) ListForResourceGroupComplete 

func (c RoleAssignmentsClient) ListForResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId, options ListForResourceGroupOperationOptions) (ListForResourceGroupCompleteResult, error)

ListForResourceGroupComplete retrieves all the results into a single object

func (RoleAssignmentsClient) ListForResourceGroupCompleteMatchingPredicate 

func (c RoleAssignmentsClient) ListForResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options ListForResourceGroupOperationOptions, predicate RoleAssignmentOperationPredicate) (result ListForResourceGroupCompleteResult, err error)

ListForResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (RoleAssignmentsClient) ListForScope 

func (c RoleAssignmentsClient) ListForScope(ctx context.Context, id commonids.ScopeId, options ListForScopeOperationOptions) (result ListForScopeOperationResponse, err error)

ListForScope ...

func (RoleAssignmentsClient) ListForScopeComplete 

func (c RoleAssignmentsClient) ListForScopeComplete(ctx context.Context, id commonids.ScopeId, options ListForScopeOperationOptions) (ListForScopeCompleteResult, error)

ListForScopeComplete retrieves all the results into a single object

func (RoleAssignmentsClient) ListForScopeCompleteMatchingPredicate 

func (c RoleAssignmentsClient) ListForScopeCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options ListForScopeOperationOptions, predicate RoleAssignmentOperationPredicate) (result ListForScopeCompleteResult, err error)

ListForScopeCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (RoleAssignmentsClient) ListForSubscription 

func (c RoleAssignmentsClient) ListForSubscription(ctx context.Context, id commonids.SubscriptionId, options ListForSubscriptionOperationOptions) (result ListForSubscriptionOperationResponse, err error)

ListForSubscription ...

func (RoleAssignmentsClient) ListForSubscriptionComplete 

func (c RoleAssignmentsClient) ListForSubscriptionComplete(ctx context.Context, id commonids.SubscriptionId, options ListForSubscriptionOperationOptions) (ListForSubscriptionCompleteResult, error)

ListForSubscriptionComplete retrieves all the results into a single object

func (RoleAssignmentsClient) ListForSubscriptionCompleteMatchingPredicate 

func (c RoleAssignmentsClient) ListForSubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListForSubscriptionOperationOptions, predicate RoleAssignmentOperationPredicate) (result ListForSubscriptionCompleteResult, err error)

ListForSubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ScopedRoleAssignmentId 

type ScopedRoleAssignmentId struct {
	Scope              string
	RoleAssignmentName string
}

ScopedRoleAssignmentId is a struct representing the Resource ID for a Scoped Role Assignment

func NewScopedRoleAssignmentID 

func NewScopedRoleAssignmentID(scope string, roleAssignmentName string) ScopedRoleAssignmentId

NewScopedRoleAssignmentID returns a new ScopedRoleAssignmentId struct

func ParseScopedRoleAssignmentID 

func ParseScopedRoleAssignmentID(input string) (*ScopedRoleAssignmentId, error)

ParseScopedRoleAssignmentID parses 'input' into a ScopedRoleAssignmentId

func ParseScopedRoleAssignmentIDInsensitively 

func ParseScopedRoleAssignmentIDInsensitively(input string) (*ScopedRoleAssignmentId, error)

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

func (*ScopedRoleAssignmentId) FromParseResult 

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

func (ScopedRoleAssignmentId) ID 

func (id ScopedRoleAssignmentId) ID() string

ID returns the formatted Scoped Role Assignment ID

func (ScopedRoleAssignmentId) Segments 

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

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

func (ScopedRoleAssignmentId) String 

func (id ScopedRoleAssignmentId) String() string

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

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.