sitelistpermission

package
v0.20241029.1112340 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/groups/beta/sitelistpermission Documentation

The sitelistpermission SDK allows for interaction with Microsoft Graph groups (API Version beta).

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/beta/sitelistpermission"

Client Initialization

client := sitelistpermission.NewSiteListPermissionClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: SiteListPermissionClient.CreateSiteListPermission

ctx := context.TODO()
id := sitelistpermission.NewGroupIdSiteIdListID("groupId", "siteId", "listId")

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


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

Example Usage: SiteListPermissionClient.DeleteSiteListPermission

ctx := context.TODO()
id := sitelistpermission.NewGroupIdSiteIdListIdPermissionID("groupId", "siteId", "listId", "permissionId")

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

Example Usage: SiteListPermissionClient.GetSiteListPermission

ctx := context.TODO()
id := sitelistpermission.NewGroupIdSiteIdListIdPermissionID("groupId", "siteId", "listId", "permissionId")

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

Example Usage: SiteListPermissionClient.GetSiteListPermissionsCount

ctx := context.TODO()
id := sitelistpermission.NewGroupIdSiteIdListID("groupId", "siteId", "listId")

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

Example Usage: SiteListPermissionClient.ListSiteListPermissionGrants

ctx := context.TODO()
id := sitelistpermission.NewGroupIdSiteIdListIdPermissionID("groupId", "siteId", "listId", "permissionId")

payload := sitelistpermission.ListSiteListPermissionGrantsRequest{
	// ...
}


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

Example Usage: SiteListPermissionClient.ListSiteListPermissions

ctx := context.TODO()
id := sitelistpermission.NewGroupIdSiteIdListID("groupId", "siteId", "listId")

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

Example Usage: SiteListPermissionClient.RevokeSiteListPermissionGrants

ctx := context.TODO()
id := sitelistpermission.NewGroupIdSiteIdListIdPermissionID("groupId", "siteId", "listId", "permissionId")

payload := sitelistpermission.RevokeSiteListPermissionGrantsRequest{
	// ...
}


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

Example Usage: SiteListPermissionClient.UpdateSiteListPermission

ctx := context.TODO()
id := sitelistpermission.NewGroupIdSiteIdListIdPermissionID("groupId", "siteId", "listId", "permissionId")

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


read, err := client.UpdateSiteListPermission(ctx, id, payload, sitelistpermission.DefaultUpdateSiteListPermissionOperationOptions())
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 CreateSiteListPermissionOperationOptions

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

func DefaultCreateSiteListPermissionOperationOptions

func DefaultCreateSiteListPermissionOperationOptions() CreateSiteListPermissionOperationOptions

func (CreateSiteListPermissionOperationOptions) ToHeaders

func (CreateSiteListPermissionOperationOptions) ToOData

func (CreateSiteListPermissionOperationOptions) ToQuery

type CreateSiteListPermissionOperationResponse

type CreateSiteListPermissionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.Permission
}

type DeleteSiteListPermissionOperationOptions

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

func DefaultDeleteSiteListPermissionOperationOptions

func DefaultDeleteSiteListPermissionOperationOptions() DeleteSiteListPermissionOperationOptions

func (DeleteSiteListPermissionOperationOptions) ToHeaders

func (DeleteSiteListPermissionOperationOptions) ToOData

func (DeleteSiteListPermissionOperationOptions) ToQuery

type DeleteSiteListPermissionOperationResponse

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

type GetSiteListPermissionOperationOptions

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

func DefaultGetSiteListPermissionOperationOptions

func DefaultGetSiteListPermissionOperationOptions() GetSiteListPermissionOperationOptions

func (GetSiteListPermissionOperationOptions) ToHeaders

func (GetSiteListPermissionOperationOptions) ToOData

func (GetSiteListPermissionOperationOptions) ToQuery

type GetSiteListPermissionOperationResponse

type GetSiteListPermissionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.Permission
}

type GetSiteListPermissionsCountOperationOptions

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

func DefaultGetSiteListPermissionsCountOperationOptions

func DefaultGetSiteListPermissionsCountOperationOptions() GetSiteListPermissionsCountOperationOptions

func (GetSiteListPermissionsCountOperationOptions) ToHeaders

func (GetSiteListPermissionsCountOperationOptions) ToOData

func (GetSiteListPermissionsCountOperationOptions) ToQuery

type GetSiteListPermissionsCountOperationResponse

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

type ListSiteListPermissionGrantsCompleteResult

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

type ListSiteListPermissionGrantsCustomPager

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

type ListSiteListPermissionGrantsOperationOptions

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

func DefaultListSiteListPermissionGrantsOperationOptions

func DefaultListSiteListPermissionGrantsOperationOptions() ListSiteListPermissionGrantsOperationOptions

func (ListSiteListPermissionGrantsOperationOptions) ToHeaders

func (ListSiteListPermissionGrantsOperationOptions) ToOData

func (ListSiteListPermissionGrantsOperationOptions) ToQuery

type ListSiteListPermissionGrantsOperationResponse

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

type ListSiteListPermissionGrantsRequest

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

type ListSiteListPermissionsCompleteResult

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

type ListSiteListPermissionsCustomPager

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

type ListSiteListPermissionsOperationOptions

type ListSiteListPermissionsOperationOptions 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 DefaultListSiteListPermissionsOperationOptions

func DefaultListSiteListPermissionsOperationOptions() ListSiteListPermissionsOperationOptions

func (ListSiteListPermissionsOperationOptions) ToHeaders

func (ListSiteListPermissionsOperationOptions) ToOData

func (ListSiteListPermissionsOperationOptions) ToQuery

type ListSiteListPermissionsOperationResponse

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

type PermissionOperationPredicate

type PermissionOperationPredicate struct {
}

func (PermissionOperationPredicate) Matches

type RevokeSiteListPermissionGrantsOperationOptions

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

func DefaultRevokeSiteListPermissionGrantsOperationOptions

func DefaultRevokeSiteListPermissionGrantsOperationOptions() RevokeSiteListPermissionGrantsOperationOptions

func (RevokeSiteListPermissionGrantsOperationOptions) ToHeaders

func (RevokeSiteListPermissionGrantsOperationOptions) ToOData

func (RevokeSiteListPermissionGrantsOperationOptions) ToQuery

type RevokeSiteListPermissionGrantsOperationResponse

type RevokeSiteListPermissionGrantsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.Permission
}

type RevokeSiteListPermissionGrantsRequest

type RevokeSiteListPermissionGrantsRequest struct {
	Grantees *[]beta.DriveRecipient `json:"grantees,omitempty"`
}

type SiteListPermissionClient

type SiteListPermissionClient struct {
	Client *msgraph.Client
}

func NewSiteListPermissionClientWithBaseURI

func NewSiteListPermissionClientWithBaseURI(sdkApi sdkEnv.Api) (*SiteListPermissionClient, error)

func (SiteListPermissionClient) CreateSiteListPermission

CreateSiteListPermission - Create new navigation property to permissions for groups

func (SiteListPermissionClient) DeleteSiteListPermission

DeleteSiteListPermission - Delete navigation property permissions for groups

func (SiteListPermissionClient) GetSiteListPermission

GetSiteListPermission - Get permissions from groups. The set of permissions for the item. Read-only. Nullable.

func (SiteListPermissionClient) GetSiteListPermissionsCount

GetSiteListPermissionsCount - Get the number of the resource

func (SiteListPermissionClient) ListSiteListPermissionGrants

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

func (SiteListPermissionClient) ListSiteListPermissionGrantsComplete

ListSiteListPermissionGrantsComplete retrieves all the results into a single object

func (SiteListPermissionClient) ListSiteListPermissionGrantsCompleteMatchingPredicate

ListSiteListPermissionGrantsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SiteListPermissionClient) ListSiteListPermissions

ListSiteListPermissions - Get permissions from groups. The set of permissions for the item. Read-only. Nullable.

func (SiteListPermissionClient) ListSiteListPermissionsComplete

ListSiteListPermissionsComplete retrieves all the results into a single object

func (SiteListPermissionClient) ListSiteListPermissionsCompleteMatchingPredicate

ListSiteListPermissionsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SiteListPermissionClient) RevokeSiteListPermissionGrants

RevokeSiteListPermissionGrants - Invoke action revokeGrants. Revoke access to a listItem or driveItem granted via a sharing link by removing the specified recipient from the link.

func (SiteListPermissionClient) UpdateSiteListPermission

UpdateSiteListPermission - Update the navigation property permissions in groups

type UpdateSiteListPermissionOperationOptions

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

func DefaultUpdateSiteListPermissionOperationOptions

func DefaultUpdateSiteListPermissionOperationOptions() UpdateSiteListPermissionOperationOptions

func (UpdateSiteListPermissionOperationOptions) ToHeaders

func (UpdateSiteListPermissionOperationOptions) ToOData

func (UpdateSiteListPermissionOperationOptions) ToQuery

type UpdateSiteListPermissionOperationResponse

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL