sitepermission

package
v0.20241104.1140654 Latest Latest
Warning

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

 Go to latest Published: Nov 4, 2024 License: MPL-2.0 Imports: 8 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/groups/stable/sitepermission Documentation

The sitepermission SDK allows for interaction with Microsoft Graph groups (API Version stable).

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/microsoft-graph/groups/stable/sitepermission"

Client Initialization

client := sitepermission.NewSitePermissionClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: SitePermissionClient.CreateSitePermission

ctx := context.TODO()
id := sitepermission.NewGroupIdSiteID("groupId", "siteId")

payload := sitepermission.Permission{
	// ...
}


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

Example Usage: SitePermissionClient.DeleteSitePermission

ctx := context.TODO()
id := sitepermission.NewGroupIdSiteIdPermissionID("groupId", "siteId", "permissionId")

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

Example Usage: SitePermissionClient.GetSitePermission

ctx := context.TODO()
id := sitepermission.NewGroupIdSiteIdPermissionID("groupId", "siteId", "permissionId")

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

Example Usage: SitePermissionClient.GetSitePermissionsCount

ctx := context.TODO()
id := sitepermission.NewGroupIdSiteID("groupId", "siteId")

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

Example Usage: SitePermissionClient.ListSitePermissionGrants

ctx := context.TODO()
id := sitepermission.NewGroupIdSiteIdPermissionID("groupId", "siteId", "permissionId")

payload := sitepermission.ListSitePermissionGrantsRequest{
	// ...
}


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

Example Usage: SitePermissionClient.ListSitePermissions

ctx := context.TODO()
id := sitepermission.NewGroupIdSiteID("groupId", "siteId")

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

Example Usage: SitePermissionClient.UpdateSitePermission

ctx := context.TODO()
id := sitepermission.NewGroupIdSiteIdPermissionID("groupId", "siteId", "permissionId")

payload := sitepermission.Permission{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateSitePermissionOperationOptions 

type CreateSitePermissionOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultCreateSitePermissionOperationOptions 

func DefaultCreateSitePermissionOperationOptions() CreateSitePermissionOperationOptions

func (CreateSitePermissionOperationOptions) ToHeaders 

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

func (CreateSitePermissionOperationOptions) ToOData 

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

func (CreateSitePermissionOperationOptions) ToQuery 

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

type CreateSitePermissionOperationResponse 

type CreateSitePermissionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.Permission
}

type DeleteSitePermissionOperationOptions 

type DeleteSitePermissionOperationOptions struct {
	IfMatch   *string
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultDeleteSitePermissionOperationOptions 

func DefaultDeleteSitePermissionOperationOptions() DeleteSitePermissionOperationOptions

func (DeleteSitePermissionOperationOptions) ToHeaders 

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

func (DeleteSitePermissionOperationOptions) ToOData 

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

func (DeleteSitePermissionOperationOptions) ToQuery 

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

type DeleteSitePermissionOperationResponse 

type DeleteSitePermissionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetSitePermissionOperationOptions 

type GetSitePermissionOperationOptions struct {
	Expand    *odata.Expand
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Select    *[]string
}

func DefaultGetSitePermissionOperationOptions 

func DefaultGetSitePermissionOperationOptions() GetSitePermissionOperationOptions

func (GetSitePermissionOperationOptions) ToHeaders 

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

func (GetSitePermissionOperationOptions) ToOData 

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

func (GetSitePermissionOperationOptions) ToQuery 

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

type GetSitePermissionOperationResponse 

type GetSitePermissionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.Permission
}

type GetSitePermissionsCountOperationOptions 

type GetSitePermissionsCountOperationOptions struct {
	Filter    *string
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Search    *string
}

func DefaultGetSitePermissionsCountOperationOptions 

func DefaultGetSitePermissionsCountOperationOptions() GetSitePermissionsCountOperationOptions

func (GetSitePermissionsCountOperationOptions) ToHeaders 

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

func (GetSitePermissionsCountOperationOptions) ToOData 

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

func (GetSitePermissionsCountOperationOptions) ToQuery 

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

type GetSitePermissionsCountOperationResponse 

type GetSitePermissionsCountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]byte
}

type ListSitePermissionGrantsCompleteResult 

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

type ListSitePermissionGrantsCustomPager 

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

type ListSitePermissionGrantsOperationOptions 

type ListSitePermissionGrantsOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Skip      *int64
	Top       *int64
}

func DefaultListSitePermissionGrantsOperationOptions 

func DefaultListSitePermissionGrantsOperationOptions() ListSitePermissionGrantsOperationOptions

func (ListSitePermissionGrantsOperationOptions) ToHeaders 

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

func (ListSitePermissionGrantsOperationOptions) ToOData 

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

func (ListSitePermissionGrantsOperationOptions) ToQuery 

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

type ListSitePermissionGrantsOperationResponse 

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

type ListSitePermissionGrantsRequest 

type ListSitePermissionGrantsRequest struct {
	Recipients *[]stable.DriveRecipient `json:"recipients,omitempty"`
	Roles      *[]string                `json:"roles,omitempty"`
}

type ListSitePermissionsCompleteResult 

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

type ListSitePermissionsCustomPager 

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

type ListSitePermissionsOperationOptions 

type ListSitePermissionsOperationOptions struct {
	Count     *bool
	Expand    *odata.Expand
	Filter    *string
	Metadata  *odata.Metadata
	OrderBy   *odata.OrderBy
	RetryFunc client.RequestRetryFunc
	Search    *string
	Select    *[]string
	Skip      *int64
	Top       *int64
}

func DefaultListSitePermissionsOperationOptions 

func DefaultListSitePermissionsOperationOptions() ListSitePermissionsOperationOptions

func (ListSitePermissionsOperationOptions) ToHeaders 

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

func (ListSitePermissionsOperationOptions) ToOData 

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

func (ListSitePermissionsOperationOptions) ToQuery 

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

type ListSitePermissionsOperationResponse 

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

type PermissionOperationPredicate 

type PermissionOperationPredicate struct {
}

func (PermissionOperationPredicate) Matches 

func (p PermissionOperationPredicate) Matches(input stable.Permission) bool

type SitePermissionClient 

type SitePermissionClient struct {
	Client *msgraph.Client
}

func NewSitePermissionClientWithBaseURI 

func NewSitePermissionClientWithBaseURI(sdkApi sdkEnv.Api) (*SitePermissionClient, error)

func (SitePermissionClient) CreateSitePermission 

func (c SitePermissionClient) CreateSitePermission(ctx context.Context, id stable.GroupIdSiteId, input stable.Permission, options CreateSitePermissionOperationOptions) (result CreateSitePermissionOperationResponse, err error)

CreateSitePermission - Create new navigation property to permissions for groups

func (SitePermissionClient) DeleteSitePermission 

func (c SitePermissionClient) DeleteSitePermission(ctx context.Context, id stable.GroupIdSiteIdPermissionId, options DeleteSitePermissionOperationOptions) (result DeleteSitePermissionOperationResponse, err error)

DeleteSitePermission - Delete navigation property permissions for groups

func (SitePermissionClient) GetSitePermission 

func (c SitePermissionClient) GetSitePermission(ctx context.Context, id stable.GroupIdSiteIdPermissionId, options GetSitePermissionOperationOptions) (result GetSitePermissionOperationResponse, err error)

GetSitePermission - Get permissions from groups. The permissions associated with the site. Nullable.

func (SitePermissionClient) GetSitePermissionsCount 

func (c SitePermissionClient) GetSitePermissionsCount(ctx context.Context, id stable.GroupIdSiteId, options GetSitePermissionsCountOperationOptions) (result GetSitePermissionsCountOperationResponse, err error)

GetSitePermissionsCount - Get the number of the resource

func (SitePermissionClient) ListSitePermissionGrants 

func (c SitePermissionClient) ListSitePermissionGrants(ctx context.Context, id stable.GroupIdSiteIdPermissionId, input ListSitePermissionGrantsRequest, options ListSitePermissionGrantsOperationOptions) (result ListSitePermissionGrantsOperationResponse, err error)

ListSitePermissionGrants - Invoke action grant. Grant users access to a link represented by a permission.

func (SitePermissionClient) ListSitePermissionGrantsComplete 

func (c SitePermissionClient) ListSitePermissionGrantsComplete(ctx context.Context, id stable.GroupIdSiteIdPermissionId, input ListSitePermissionGrantsRequest, options ListSitePermissionGrantsOperationOptions) (ListSitePermissionGrantsCompleteResult, error)

ListSitePermissionGrantsComplete retrieves all the results into a single object

func (SitePermissionClient) ListSitePermissionGrantsCompleteMatchingPredicate 

func (c SitePermissionClient) ListSitePermissionGrantsCompleteMatchingPredicate(ctx context.Context, id stable.GroupIdSiteIdPermissionId, input ListSitePermissionGrantsRequest, options ListSitePermissionGrantsOperationOptions, predicate PermissionOperationPredicate) (result ListSitePermissionGrantsCompleteResult, err error)

ListSitePermissionGrantsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SitePermissionClient) ListSitePermissions 

func (c SitePermissionClient) ListSitePermissions(ctx context.Context, id stable.GroupIdSiteId, options ListSitePermissionsOperationOptions) (result ListSitePermissionsOperationResponse, err error)

ListSitePermissions - Get permissions from groups. The permissions associated with the site. Nullable.

func (SitePermissionClient) ListSitePermissionsComplete 

func (c SitePermissionClient) ListSitePermissionsComplete(ctx context.Context, id stable.GroupIdSiteId, options ListSitePermissionsOperationOptions) (ListSitePermissionsCompleteResult, error)

ListSitePermissionsComplete retrieves all the results into a single object

func (SitePermissionClient) ListSitePermissionsCompleteMatchingPredicate 

func (c SitePermissionClient) ListSitePermissionsCompleteMatchingPredicate(ctx context.Context, id stable.GroupIdSiteId, options ListSitePermissionsOperationOptions, predicate PermissionOperationPredicate) (result ListSitePermissionsCompleteResult, err error)

ListSitePermissionsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SitePermissionClient) UpdateSitePermission 

func (c SitePermissionClient) UpdateSitePermission(ctx context.Context, id stable.GroupIdSiteIdPermissionId, input stable.Permission, options UpdateSitePermissionOperationOptions) (result UpdateSitePermissionOperationResponse, err error)

UpdateSitePermission - Update the navigation property permissions in groups

type UpdateSitePermissionOperationOptions 

type UpdateSitePermissionOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultUpdateSitePermissionOperationOptions 

func DefaultUpdateSitePermissionOperationOptions() UpdateSitePermissionOperationOptions

func (UpdateSitePermissionOperationOptions) ToHeaders 

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

func (UpdateSitePermissionOperationOptions) ToOData 

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

func (UpdateSitePermissionOperationOptions) ToQuery 

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

type UpdateSitePermissionOperationResponse 

type UpdateSitePermissionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

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.