permissions

README

github.com/hashicorp/go-azure-sdk/resource-manager/authorization/2022-05-01-preview/permissions Documentation

The permissions SDK allows for interaction with Azure Resource Manager authorization (API Version 2022-05-01-preview).

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-05-01-preview/permissions"

Client Initialization

client := permissions.NewPermissionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PermissionsClient.ListForResource

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

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

Example Usage: PermissionsClient.ListForResourceGroup

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

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

Documentation

Index

• type ListForResourceCompleteResult
• type ListForResourceCustomPager
  • func (p *ListForResourceCustomPager) NextPageLink() *odata.Link
• type ListForResourceGroupCompleteResult
• type ListForResourceGroupCustomPager
  • func (p *ListForResourceGroupCustomPager) NextPageLink() *odata.Link
• type ListForResourceGroupOperationResponse
• type ListForResourceOperationResponse
• type Permission
• type PermissionOperationPredicate
  • func (p PermissionOperationPredicate) Matches(input Permission) bool
• type PermissionsClient
  • func NewPermissionsClientWithBaseURI(sdkApi sdkEnv.Api) (*PermissionsClient, error)
  • func (c PermissionsClient) ListForResource(ctx context.Context, id commonids.ScopeId) (result ListForResourceOperationResponse, err error)
  • func (c PermissionsClient) ListForResourceComplete(ctx context.Context, id commonids.ScopeId) (ListForResourceCompleteResult, error)
  • func (c PermissionsClient) ListForResourceCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, ...) (result ListForResourceCompleteResult, err error)
  • func (c PermissionsClient) ListForResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListForResourceGroupOperationResponse, err error)
  • func (c PermissionsClient) ListForResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListForResourceGroupCompleteResult, error)
  • func (c PermissionsClient) ListForResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (result ListForResourceGroupCompleteResult, err error)

Types

type ListForResourceCompleteResult

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

type ListForResourceCustomPager

type ListForResourceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListForResourceCustomPager) NextPageLink

func (p *ListForResourceCustomPager) NextPageLink() *odata.Link

type ListForResourceGroupCompleteResult

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

type ListForResourceGroupCustomPager

type ListForResourceGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListForResourceGroupCustomPager) NextPageLink

func (p *ListForResourceGroupCustomPager) NextPageLink() *odata.Link

type ListForResourceGroupOperationResponse

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

type ListForResourceOperationResponse

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

type Permission

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

type PermissionOperationPredicate

type PermissionOperationPredicate struct {
	Condition        *string
	ConditionVersion *string
}

func (PermissionOperationPredicate) Matches

func (p PermissionOperationPredicate) Matches(input Permission) bool

type PermissionsClient

type PermissionsClient struct {
	Client *resourcemanager.Client
}

func NewPermissionsClientWithBaseURI

func NewPermissionsClientWithBaseURI(sdkApi sdkEnv.Api) (*PermissionsClient, error)

func (PermissionsClient) ListForResource

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

ListForResource ...

func (PermissionsClient) ListForResourceComplete

func (c PermissionsClient) ListForResourceComplete(ctx context.Context, id commonids.ScopeId) (ListForResourceCompleteResult, error)

ListForResourceComplete retrieves all the results into a single object

func (PermissionsClient) ListForResourceCompleteMatchingPredicate

func (c PermissionsClient) ListForResourceCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, predicate PermissionOperationPredicate) (result ListForResourceCompleteResult, err error)

ListForResourceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PermissionsClient) ListForResourceGroup

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

ListForResourceGroup ...

func (PermissionsClient) ListForResourceGroupComplete

func (c PermissionsClient) ListForResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListForResourceGroupCompleteResult, error)

ListForResourceGroupComplete retrieves all the results into a single object

func (PermissionsClient) ListForResourceGroupCompleteMatchingPredicate

func (c PermissionsClient) ListForResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate PermissionOperationPredicate) (result ListForResourceGroupCompleteResult, err error)

ListForResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate