group

package
v0.20241128.1084944 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := group.NewGroupClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: GroupClient.AddFavorite

ctx := context.TODO()
id := group.NewGroupID("groupId")

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

Example Usage: GroupClient.AssignLicense

ctx := context.TODO()
id := group.NewGroupID("groupId")

payload := group.AssignLicenseRequest{
	// ...
}


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

Example Usage: GroupClient.CheckGrantedPermissionsForApps

ctx := context.TODO()
id := group.NewGroupID("groupId")

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

Example Usage: GroupClient.CheckMemberGroups

ctx := context.TODO()
id := group.NewGroupID("groupId")

payload := group.CheckMemberGroupsRequest{
	// ...
}


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

Example Usage: GroupClient.CheckMemberObjects

ctx := context.TODO()
id := group.NewGroupID("groupId")

payload := group.CheckMemberObjectsRequest{
	// ...
}


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

Example Usage: GroupClient.CreateGroup

ctx := context.TODO()

payload := group.Group{
	// ...
}


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

Example Usage: GroupClient.CreateSubscribeByMail

ctx := context.TODO()
id := group.NewGroupID("groupId")

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

Example Usage: GroupClient.CreateUnsubscribeByMail

ctx := context.TODO()
id := group.NewGroupID("groupId")

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

Example Usage: GroupClient.CreateValidatesProperty

ctx := context.TODO()

payload := group.CreateValidatesPropertyRequest{
	// ...
}


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

Example Usage: GroupClient.DeleteGroup

ctx := context.TODO()
id := group.NewGroupID("groupId")

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

Example Usage: GroupClient.GetGroup

ctx := context.TODO()
id := group.NewGroupID("groupId")

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

Example Usage: GroupClient.GetMemberGroups

ctx := context.TODO()
id := group.NewGroupID("groupId")

payload := group.GetMemberGroupsRequest{
	// ...
}


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

Example Usage: GroupClient.GetMemberObjects

ctx := context.TODO()
id := group.NewGroupID("groupId")

payload := group.GetMemberObjectsRequest{
	// ...
}


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

Example Usage: GroupClient.GetsCount

ctx := context.TODO()


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

Example Usage: GroupClient.ListGetsAvailableExtensionProperties

ctx := context.TODO()

payload := group.ListGetsAvailableExtensionPropertiesRequest{
	// ...
}


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

Example Usage: GroupClient.ListGetsByIds

ctx := context.TODO()

payload := group.ListGetsByIdsRequest{
	// ...
}


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

Example Usage: GroupClient.ListGroups

ctx := context.TODO()


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

Example Usage: GroupClient.RemoveFavorite

ctx := context.TODO()
id := group.NewGroupID("groupId")

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

Example Usage: GroupClient.Renew

ctx := context.TODO()
id := group.NewGroupID("groupId")

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

Example Usage: GroupClient.ResetUnseenCount

ctx := context.TODO()
id := group.NewGroupID("groupId")

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

Example Usage: GroupClient.Restore

ctx := context.TODO()
id := group.NewGroupID("groupId")

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

Example Usage: GroupClient.RetryServiceProvisioning

ctx := context.TODO()
id := group.NewGroupID("groupId")

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

Example Usage: GroupClient.UpdateGroup

ctx := context.TODO()
id := group.NewGroupID("groupId")

payload := group.Group{
	// ...
}


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

Example Usage: GroupClient.ValidateProperties

ctx := context.TODO()
id := group.NewGroupID("groupId")

payload := group.ValidatePropertiesRequest{
	// ...
}


read, err := client.ValidateProperties(ctx, id, payload, group.DefaultValidatePropertiesOperationOptions())
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 AddFavoriteOperationOptions

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

func DefaultAddFavoriteOperationOptions

func DefaultAddFavoriteOperationOptions() AddFavoriteOperationOptions

func (AddFavoriteOperationOptions) ToHeaders

func (AddFavoriteOperationOptions) ToOData

func (AddFavoriteOperationOptions) ToQuery

type AddFavoriteOperationResponse

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

type AssignLicenseOperationOptions

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

func DefaultAssignLicenseOperationOptions

func DefaultAssignLicenseOperationOptions() AssignLicenseOperationOptions

func (AssignLicenseOperationOptions) ToHeaders

func (AssignLicenseOperationOptions) ToOData

func (AssignLicenseOperationOptions) ToQuery

type AssignLicenseOperationResponse

type AssignLicenseOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.Group
}

type AssignLicenseRequest

type AssignLicenseRequest struct {
	AddLicenses    *[]stable.AssignedLicense `json:"addLicenses,omitempty"`
	RemoveLicenses *[]string                 `json:"removeLicenses,omitempty"`
}

type CheckGrantedPermissionsForAppsCompleteResult

type CheckGrantedPermissionsForAppsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.ResourceSpecificPermissionGrant
}

type CheckGrantedPermissionsForAppsCustomPager

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

type CheckGrantedPermissionsForAppsOperationOptions

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

func DefaultCheckGrantedPermissionsForAppsOperationOptions

func DefaultCheckGrantedPermissionsForAppsOperationOptions() CheckGrantedPermissionsForAppsOperationOptions

func (CheckGrantedPermissionsForAppsOperationOptions) ToHeaders

func (CheckGrantedPermissionsForAppsOperationOptions) ToOData

func (CheckGrantedPermissionsForAppsOperationOptions) ToQuery

type CheckGrantedPermissionsForAppsOperationResponse

type CheckGrantedPermissionsForAppsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.ResourceSpecificPermissionGrant
}

type CheckMemberGroupsCompleteResult

type CheckMemberGroupsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []string
}

type CheckMemberGroupsCustomPager

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

type CheckMemberGroupsOperationOptions

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

func DefaultCheckMemberGroupsOperationOptions

func DefaultCheckMemberGroupsOperationOptions() CheckMemberGroupsOperationOptions

func (CheckMemberGroupsOperationOptions) ToHeaders

func (CheckMemberGroupsOperationOptions) ToOData

func (CheckMemberGroupsOperationOptions) ToQuery

type CheckMemberGroupsOperationResponse

type CheckMemberGroupsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]string
}

type CheckMemberGroupsRequest

type CheckMemberGroupsRequest struct {
	GroupIds *[]string `json:"groupIds,omitempty"`
}

type CheckMemberObjectsCompleteResult

type CheckMemberObjectsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []string
}

type CheckMemberObjectsCustomPager

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

type CheckMemberObjectsOperationOptions

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

func DefaultCheckMemberObjectsOperationOptions

func DefaultCheckMemberObjectsOperationOptions() CheckMemberObjectsOperationOptions

func (CheckMemberObjectsOperationOptions) ToHeaders

func (CheckMemberObjectsOperationOptions) ToOData

func (CheckMemberObjectsOperationOptions) ToQuery

type CheckMemberObjectsOperationResponse

type CheckMemberObjectsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]string
}

type CheckMemberObjectsRequest

type CheckMemberObjectsRequest struct {
	Ids *[]string `json:"ids,omitempty"`
}

type CreateGroupOperationOptions

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

func DefaultCreateGroupOperationOptions

func DefaultCreateGroupOperationOptions() CreateGroupOperationOptions

func (CreateGroupOperationOptions) ToHeaders

func (CreateGroupOperationOptions) ToOData

func (CreateGroupOperationOptions) ToQuery

type CreateGroupOperationResponse

type CreateGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.Group
}

type CreateSubscribeByMailOperationOptions

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

func DefaultCreateSubscribeByMailOperationOptions

func DefaultCreateSubscribeByMailOperationOptions() CreateSubscribeByMailOperationOptions

func (CreateSubscribeByMailOperationOptions) ToHeaders

func (CreateSubscribeByMailOperationOptions) ToOData

func (CreateSubscribeByMailOperationOptions) ToQuery

type CreateSubscribeByMailOperationResponse

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

type CreateUnsubscribeByMailOperationOptions

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

func DefaultCreateUnsubscribeByMailOperationOptions

func DefaultCreateUnsubscribeByMailOperationOptions() CreateUnsubscribeByMailOperationOptions

func (CreateUnsubscribeByMailOperationOptions) ToHeaders

func (CreateUnsubscribeByMailOperationOptions) ToOData

func (CreateUnsubscribeByMailOperationOptions) ToQuery

type CreateUnsubscribeByMailOperationResponse

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

type CreateValidatesPropertyOperationOptions

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

func DefaultCreateValidatesPropertyOperationOptions

func DefaultCreateValidatesPropertyOperationOptions() CreateValidatesPropertyOperationOptions

func (CreateValidatesPropertyOperationOptions) ToHeaders

func (CreateValidatesPropertyOperationOptions) ToOData

func (CreateValidatesPropertyOperationOptions) ToQuery

type CreateValidatesPropertyOperationResponse

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

type CreateValidatesPropertyRequest

type CreateValidatesPropertyRequest struct {
	DisplayName      nullable.Type[string] `json:"displayName,omitempty"`
	EntityType       nullable.Type[string] `json:"entityType,omitempty"`
	MailNickname     nullable.Type[string] `json:"mailNickname,omitempty"`
	OnBehalfOfUserId nullable.Type[string] `json:"onBehalfOfUserId,omitempty"`
}

type DeleteGroupOperationOptions

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

func DefaultDeleteGroupOperationOptions

func DefaultDeleteGroupOperationOptions() DeleteGroupOperationOptions

func (DeleteGroupOperationOptions) ToHeaders

func (DeleteGroupOperationOptions) ToOData

func (DeleteGroupOperationOptions) ToQuery

type DeleteGroupOperationResponse

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

type DirectoryObjectOperationPredicate

type DirectoryObjectOperationPredicate struct {
}

func (DirectoryObjectOperationPredicate) Matches

type ExtensionPropertyOperationPredicate

type ExtensionPropertyOperationPredicate struct {
}

func (ExtensionPropertyOperationPredicate) Matches

type GetGroupOperationOptions

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

func DefaultGetGroupOperationOptions

func DefaultGetGroupOperationOptions() GetGroupOperationOptions

func (GetGroupOperationOptions) ToHeaders

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

func (GetGroupOperationOptions) ToOData

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

func (GetGroupOperationOptions) ToQuery

type GetGroupOperationResponse

type GetGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.Group
}

type GetMemberGroupsCompleteResult

type GetMemberGroupsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []string
}

type GetMemberGroupsCustomPager

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

type GetMemberGroupsOperationOptions

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

func DefaultGetMemberGroupsOperationOptions

func DefaultGetMemberGroupsOperationOptions() GetMemberGroupsOperationOptions

func (GetMemberGroupsOperationOptions) ToHeaders

func (GetMemberGroupsOperationOptions) ToOData

func (GetMemberGroupsOperationOptions) ToQuery

type GetMemberGroupsOperationResponse

type GetMemberGroupsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]string
}

type GetMemberGroupsRequest

type GetMemberGroupsRequest struct {
	SecurityEnabledOnly nullable.Type[bool] `json:"securityEnabledOnly,omitempty"`
}

type GetMemberObjectsCompleteResult

type GetMemberObjectsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []string
}

type GetMemberObjectsCustomPager

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

type GetMemberObjectsOperationOptions

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

func DefaultGetMemberObjectsOperationOptions

func DefaultGetMemberObjectsOperationOptions() GetMemberObjectsOperationOptions

func (GetMemberObjectsOperationOptions) ToHeaders

func (GetMemberObjectsOperationOptions) ToOData

func (GetMemberObjectsOperationOptions) ToQuery

type GetMemberObjectsOperationResponse

type GetMemberObjectsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]string
}

type GetMemberObjectsRequest

type GetMemberObjectsRequest struct {
	SecurityEnabledOnly nullable.Type[bool] `json:"securityEnabledOnly,omitempty"`
}

type GetsCountOperationOptions

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

func DefaultGetsCountOperationOptions

func DefaultGetsCountOperationOptions() GetsCountOperationOptions

func (GetsCountOperationOptions) ToHeaders

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

func (GetsCountOperationOptions) ToOData

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

func (GetsCountOperationOptions) ToQuery

type GetsCountOperationResponse

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

type GroupClient

type GroupClient struct {
	Client *msgraph.Client
}

func NewGroupClientWithBaseURI

func NewGroupClientWithBaseURI(sdkApi sdkEnv.Api) (*GroupClient, error)

func (GroupClient) AddFavorite

AddFavorite - Invoke action addFavorite. Add the group to the list of the current user's favorite groups. The group shows up in Outlook and Teams favorites. Supported for Microsoft 365 groups only.

func (GroupClient) AssignLicense

AssignLicense - Invoke action assignLicense. Add or remove licenses on the group. Licenses assigned to the group will be assigned to all users in the group. To learn more about group-based licensing, see What is group-based licensing in Microsoft Entra ID. To get the subscriptions available in the directory, perform a GET subscribedSkus request.

func (GroupClient) CheckGrantedPermissionsForApps

CheckGrantedPermissionsForApps - Invoke action checkGrantedPermissionsForApp

func (GroupClient) CheckGrantedPermissionsForAppsComplete

CheckGrantedPermissionsForAppsComplete retrieves all the results into a single object

func (GroupClient) CheckGrantedPermissionsForAppsCompleteMatchingPredicate

CheckGrantedPermissionsForAppsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (GroupClient) CheckMemberGroups

CheckMemberGroups - Invoke action checkMemberGroups. Check for membership in a specified list of group IDs, and return from that list those groups (identified by IDs) of which the specified user, group, service principal, organizational contact, device, or directory object is a member. This function is transitive. You can check up to a maximum of 20 groups per request. This function supports all groups provisioned in Microsoft Entra ID. Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct.

func (GroupClient) CheckMemberGroupsComplete

CheckMemberGroupsComplete retrieves all the results into a single object

func (GroupClient) CheckMemberObjects

CheckMemberObjects - Invoke action checkMemberObjects

func (GroupClient) CheckMemberObjectsComplete

CheckMemberObjectsComplete retrieves all the results into a single object

func (GroupClient) CreateGroup

func (c GroupClient) CreateGroup(ctx context.Context, input stable.Group, options CreateGroupOperationOptions) (result CreateGroupOperationResponse, err error)

CreateGroup - Upsert group. Create a new group object if it doesn't exist, or update the properties of an existing group object. You can create or update the following types of group: By default, this operation returns only a subset of the properties for each group. For a list of properties that are returned by default, see the Properties section of the group resource. To get properties that are not returned by default, do a GET operation and specify the properties in a $select OData query option.

func (GroupClient) CreateSubscribeByMail

CreateSubscribeByMail - Invoke action subscribeByMail. Calling this method will enable the current user to receive email notifications for this group, about new posts, events, and files in that group. Supported for Microsoft 365 groups only.

func (GroupClient) CreateUnsubscribeByMail

CreateUnsubscribeByMail - Invoke action unsubscribeByMail. Calling this method prevents the current user from receiving email notifications for this group about new posts, events, and files in that group. Supported for Microsoft 365 groups only.

func (GroupClient) CreateValidatesProperty

CreateValidatesProperty - Invoke action validateProperties. Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. To validate the properties of an existing group, use the group: validateProperties function. The following policy validations are performed for the display name and mail nickname properties: 1. Validate the prefix and suffix naming policy 2. Validate the custom banned words policy 3. Validate that the mail nickname is unique This API only returns the first validation failure that is encountered. If the properties fail multiple validations, only the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy. To learn more about configuring naming policies, see Configure naming policy.

func (GroupClient) DeleteGroup

DeleteGroup - Delete group. Delete group. When deleted, Microsoft 365 groups are moved to a temporary container and can be restored within 30 days. After that time, they're permanently deleted. This isn't applicable to Security groups and Distribution groups which are permanently deleted immediately. To learn more, see deletedItems.

func (GroupClient) GetGroup

GetGroup - Get group. Get the properties and relationships of a group object. This operation returns by default only a subset of all the available properties, as noted in the Properties section. To get properties that aren't_ returned by default, specify them in a $select OData query option. The hasMembersWithLicenseErrors and isArchived properties are an exception and aren't returned in the $select query.

func (GroupClient) GetMemberGroups

GetMemberGroups - Invoke action getMemberGroups. Return all the group IDs for the groups that the specified user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. This API returns up to 11,000 group IDs. If more than 11,000 results are available, it returns a 400 Bad Request error with the DirectoryResultSizeLimitExceeded error code. If you get the DirectoryResultSizeLimitExceeded error code, use the List group transitive memberOf API instead.

func (GroupClient) GetMemberGroupsComplete

GetMemberGroupsComplete retrieves all the results into a single object

func (GroupClient) GetMemberObjects

GetMemberObjects - Invoke action getMemberObjects. Return all IDs for the groups, administrative units, and directory roles that a user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. Note: Only users and role-enabled groups can be members of directory roles.

func (GroupClient) GetMemberObjectsComplete

GetMemberObjectsComplete retrieves all the results into a single object

func (GroupClient) GetsCount

func (c GroupClient) GetsCount(ctx context.Context, options GetsCountOperationOptions) (result GetsCountOperationResponse, err error)

GetsCount - Get the number of the resource

func (GroupClient) ListGetsAvailableExtensionProperties

ListGetsAvailableExtensionProperties - Invoke action getAvailableExtensionProperties. Return all directory extension definitions that have been registered in a directory, including through multi-tenant apps. The following entities support extension properties

func (GroupClient) ListGetsAvailableExtensionPropertiesComplete

ListGetsAvailableExtensionPropertiesComplete retrieves all the results into a single object

func (GroupClient) ListGetsAvailableExtensionPropertiesCompleteMatchingPredicate

ListGetsAvailableExtensionPropertiesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (GroupClient) ListGetsByIds

ListGetsByIds - Invoke action getByIds. Return the directory objects specified in a list of IDs. Only a subset of user properties are returned by default in v1.0. Some common uses for this function are to

func (GroupClient) ListGetsByIdsComplete

ListGetsByIdsComplete retrieves all the results into a single object

func (GroupClient) ListGetsByIdsCompleteMatchingPredicate

func (c GroupClient) ListGetsByIdsCompleteMatchingPredicate(ctx context.Context, input ListGetsByIdsRequest, options ListGetsByIdsOperationOptions, predicate DirectoryObjectOperationPredicate) (result ListGetsByIdsCompleteResult, err error)

ListGetsByIdsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (GroupClient) ListGroups

ListGroups - List groups. List all the groups available in an organization, excluding dynamic distribution groups. To retrieve dynamic distribution groups, use the Exchange admin center. This operation returns by default only a subset of the properties for each group. These default properties are noted in the Properties section. To get properties that are not returned by default, do a GET operation for the group and specify the properties in a $select OData query option. The hasMembersWithLicenseErrors and isArchived properties are an exception and are not returned in the $select query.

func (GroupClient) ListGroupsComplete

ListGroupsComplete retrieves all the results into a single object

func (GroupClient) ListGroupsCompleteMatchingPredicate

func (c GroupClient) ListGroupsCompleteMatchingPredicate(ctx context.Context, options ListGroupsOperationOptions, predicate GroupOperationPredicate) (result ListGroupsCompleteResult, err error)

ListGroupsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (GroupClient) RemoveFavorite

RemoveFavorite - Invoke action removeFavorite. Remove the group from the list of the current user's favorite groups. Supported for Microsoft 365 groups only.

func (GroupClient) Renew

Renew - Invoke action renew. Renews a group's expiration. When a group is renewed, the group expiration is extended by the number of days defined in the policy.

func (GroupClient) ResetUnseenCount

ResetUnseenCount - Invoke action resetUnseenCount. Reset the unseenCount of all the posts that the current user hasn't seen since their last visit. Supported for Microsoft 365 groups only.

func (GroupClient) Restore

Restore - Invoke action restore. Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. If an item was accidentally deleted, you can fully restore the item. However, security groups cannot be restored. Also, restoring an application doesn't restore the associated service principal automatically. You must call this API to explicitly restore the deleted service principal. A recently deleted item remains available for up to 30 days. After 30 days, the item is permanently deleted.

func (GroupClient) RetryServiceProvisioning

RetryServiceProvisioning - Invoke action retryServiceProvisioning. Retry the group service provisioning.

func (GroupClient) UpdateGroup

UpdateGroup - Upsert group. Create a new group object if it doesn't exist, or update the properties of an existing group object. You can create or update the following types of group: By default, this operation returns only a subset of the properties for each group. For a list of properties that are returned by default, see the Properties section of the group resource. To get properties that are not returned by default, do a GET operation and specify the properties in a $select OData query option.

func (GroupClient) ValidateProperties

ValidateProperties - Invoke action validateProperties. Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to update a Microsoft 365 group. To validate the properties before creating a group, use the directoryobject:validateProperties function. The following policy validations are performed for the display name and mail nickname properties: This API only returns the first validation failure that is encountered. If the properties fail multiple validations, only the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy. To learn more about configuring naming policies, see Configure naming policy.

type GroupOperationPredicate

type GroupOperationPredicate struct {
}

func (GroupOperationPredicate) Matches

func (p GroupOperationPredicate) Matches(input stable.Group) bool

type ListGetsAvailableExtensionPropertiesCompleteResult

type ListGetsAvailableExtensionPropertiesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.ExtensionProperty
}

type ListGetsAvailableExtensionPropertiesCustomPager

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

type ListGetsAvailableExtensionPropertiesOperationOptions

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

func DefaultListGetsAvailableExtensionPropertiesOperationOptions

func DefaultListGetsAvailableExtensionPropertiesOperationOptions() ListGetsAvailableExtensionPropertiesOperationOptions

func (ListGetsAvailableExtensionPropertiesOperationOptions) ToHeaders

func (ListGetsAvailableExtensionPropertiesOperationOptions) ToOData

func (ListGetsAvailableExtensionPropertiesOperationOptions) ToQuery

type ListGetsAvailableExtensionPropertiesOperationResponse

type ListGetsAvailableExtensionPropertiesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.ExtensionProperty
}

type ListGetsAvailableExtensionPropertiesRequest

type ListGetsAvailableExtensionPropertiesRequest struct {
	IsSyncedFromOnPremises nullable.Type[bool] `json:"isSyncedFromOnPremises,omitempty"`
}

type ListGetsByIdsCompleteResult

type ListGetsByIdsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.DirectoryObject
}

type ListGetsByIdsCustomPager

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

type ListGetsByIdsOperationOptions

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

func DefaultListGetsByIdsOperationOptions

func DefaultListGetsByIdsOperationOptions() ListGetsByIdsOperationOptions

func (ListGetsByIdsOperationOptions) ToHeaders

func (ListGetsByIdsOperationOptions) ToOData

func (ListGetsByIdsOperationOptions) ToQuery

type ListGetsByIdsOperationResponse

type ListGetsByIdsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.DirectoryObject
}

type ListGetsByIdsRequest

type ListGetsByIdsRequest struct {
	Ids   *[]string `json:"ids,omitempty"`
	Types *[]string `json:"types,omitempty"`
}

type ListGroupsCompleteResult

type ListGroupsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.Group
}

type ListGroupsCustomPager

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

type ListGroupsOperationOptions

type ListGroupsOperationOptions struct {
	ConsistencyLevel *odata.ConsistencyLevel
	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 DefaultListGroupsOperationOptions

func DefaultListGroupsOperationOptions() ListGroupsOperationOptions

func (ListGroupsOperationOptions) ToHeaders

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

func (ListGroupsOperationOptions) ToOData

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

func (ListGroupsOperationOptions) ToQuery

type ListGroupsOperationResponse

type ListGroupsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.Group
}

type RemoveFavoriteOperationOptions

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

func DefaultRemoveFavoriteOperationOptions

func DefaultRemoveFavoriteOperationOptions() RemoveFavoriteOperationOptions

func (RemoveFavoriteOperationOptions) ToHeaders

func (RemoveFavoriteOperationOptions) ToOData

func (RemoveFavoriteOperationOptions) ToQuery

type RemoveFavoriteOperationResponse

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

type RenewOperationOptions

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

func DefaultRenewOperationOptions

func DefaultRenewOperationOptions() RenewOperationOptions

func (RenewOperationOptions) ToHeaders

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

func (RenewOperationOptions) ToOData

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

func (RenewOperationOptions) ToQuery

type RenewOperationResponse

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

type ResetUnseenCountOperationOptions

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

func DefaultResetUnseenCountOperationOptions

func DefaultResetUnseenCountOperationOptions() ResetUnseenCountOperationOptions

func (ResetUnseenCountOperationOptions) ToHeaders

func (ResetUnseenCountOperationOptions) ToOData

func (ResetUnseenCountOperationOptions) ToQuery

type ResetUnseenCountOperationResponse

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

type ResourceSpecificPermissionGrantOperationPredicate

type ResourceSpecificPermissionGrantOperationPredicate struct {
}

func (ResourceSpecificPermissionGrantOperationPredicate) Matches

type RestoreOperationOptions

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

func DefaultRestoreOperationOptions

func DefaultRestoreOperationOptions() RestoreOperationOptions

func (RestoreOperationOptions) ToHeaders

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

func (RestoreOperationOptions) ToOData

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

func (RestoreOperationOptions) ToQuery

type RestoreOperationResponse

type RestoreOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        stable.DirectoryObject
}

type RetryServiceProvisioningOperationOptions

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

func DefaultRetryServiceProvisioningOperationOptions

func DefaultRetryServiceProvisioningOperationOptions() RetryServiceProvisioningOperationOptions

func (RetryServiceProvisioningOperationOptions) ToHeaders

func (RetryServiceProvisioningOperationOptions) ToOData

func (RetryServiceProvisioningOperationOptions) ToQuery

type RetryServiceProvisioningOperationResponse

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

type UpdateGroupOperationOptions

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

func DefaultUpdateGroupOperationOptions

func DefaultUpdateGroupOperationOptions() UpdateGroupOperationOptions

func (UpdateGroupOperationOptions) ToHeaders

func (UpdateGroupOperationOptions) ToOData

func (UpdateGroupOperationOptions) ToQuery

type UpdateGroupOperationResponse

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

type ValidatePropertiesOperationOptions

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

func DefaultValidatePropertiesOperationOptions

func DefaultValidatePropertiesOperationOptions() ValidatePropertiesOperationOptions

func (ValidatePropertiesOperationOptions) ToHeaders

func (ValidatePropertiesOperationOptions) ToOData

func (ValidatePropertiesOperationOptions) ToQuery

type ValidatePropertiesOperationResponse

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

type ValidatePropertiesRequest

type ValidatePropertiesRequest struct {
	DisplayName      nullable.Type[string] `json:"displayName,omitempty"`
	MailNickname     nullable.Type[string] `json:"mailNickname,omitempty"`
	OnBehalfOfUserId nullable.Type[string] `json:"onBehalfOfUserId,omitempty"`
}

Jump to

Keyboard shortcuts

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