grouplifecyclepolicy

package
v0.20241111.1164443 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := grouplifecyclepolicy.NewGroupLifecyclePolicyClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: GroupLifecyclePolicyClient.AddGroupLifecyclePolicyGroup

ctx := context.TODO()
id := grouplifecyclepolicy.NewGroupIdGroupLifecyclePolicyID("groupId", "groupLifecyclePolicyId")

payload := grouplifecyclepolicy.AddGroupLifecyclePolicyGroupRequest{
	// ...
}


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

Example Usage: GroupLifecyclePolicyClient.CreateGroupLifecyclePolicy

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

payload := grouplifecyclepolicy.GroupLifecyclePolicy{
	// ...
}


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

Example Usage: GroupLifecyclePolicyClient.DeleteGroupLifecyclePolicy

ctx := context.TODO()
id := grouplifecyclepolicy.NewGroupIdGroupLifecyclePolicyID("groupId", "groupLifecyclePolicyId")

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

Example Usage: GroupLifecyclePolicyClient.GetGroupLifecyclePoliciesCount

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

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

Example Usage: GroupLifecyclePolicyClient.GetGroupLifecyclePolicy

ctx := context.TODO()
id := grouplifecyclepolicy.NewGroupIdGroupLifecyclePolicyID("groupId", "groupLifecyclePolicyId")

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

Example Usage: GroupLifecyclePolicyClient.ListGroupLifecyclePolicies

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

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

Example Usage: GroupLifecyclePolicyClient.RemoveGroupLifecyclePolicyGroup

ctx := context.TODO()
id := grouplifecyclepolicy.NewGroupIdGroupLifecyclePolicyID("groupId", "groupLifecyclePolicyId")

payload := grouplifecyclepolicy.RemoveGroupLifecyclePolicyGroupRequest{
	// ...
}


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

Example Usage: GroupLifecyclePolicyClient.UpdateGroupLifecyclePolicy

ctx := context.TODO()
id := grouplifecyclepolicy.NewGroupIdGroupLifecyclePolicyID("groupId", "groupLifecyclePolicyId")

payload := grouplifecyclepolicy.GroupLifecyclePolicy{
	// ...
}


read, err := client.UpdateGroupLifecyclePolicy(ctx, id, payload, grouplifecyclepolicy.DefaultUpdateGroupLifecyclePolicyOperationOptions())
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 AddGroupLifecyclePolicyGroupOperationOptions 

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

func DefaultAddGroupLifecyclePolicyGroupOperationOptions 

func DefaultAddGroupLifecyclePolicyGroupOperationOptions() AddGroupLifecyclePolicyGroupOperationOptions

func (AddGroupLifecyclePolicyGroupOperationOptions) ToHeaders 

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

func (AddGroupLifecyclePolicyGroupOperationOptions) ToOData 

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

func (AddGroupLifecyclePolicyGroupOperationOptions) ToQuery 

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

type AddGroupLifecyclePolicyGroupOperationResponse 

type AddGroupLifecyclePolicyGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AddGroupLifecyclePolicyGroupResult
}

type AddGroupLifecyclePolicyGroupRequest 

type AddGroupLifecyclePolicyGroupRequest struct {
	GroupId *string `json:"groupId,omitempty"`
}

type AddGroupLifecyclePolicyGroupResult 

type AddGroupLifecyclePolicyGroupResult struct {
	Value *bool `json:"value,omitempty"`
}

type CreateGroupLifecyclePolicyOperationOptions 

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

func DefaultCreateGroupLifecyclePolicyOperationOptions 

func DefaultCreateGroupLifecyclePolicyOperationOptions() CreateGroupLifecyclePolicyOperationOptions

func (CreateGroupLifecyclePolicyOperationOptions) ToHeaders 

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

func (CreateGroupLifecyclePolicyOperationOptions) ToOData 

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

func (CreateGroupLifecyclePolicyOperationOptions) ToQuery 

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

type CreateGroupLifecyclePolicyOperationResponse 

type CreateGroupLifecyclePolicyOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.GroupLifecyclePolicy
}

type DeleteGroupLifecyclePolicyOperationOptions 

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

func DefaultDeleteGroupLifecyclePolicyOperationOptions 

func DefaultDeleteGroupLifecyclePolicyOperationOptions() DeleteGroupLifecyclePolicyOperationOptions

func (DeleteGroupLifecyclePolicyOperationOptions) ToHeaders 

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

func (DeleteGroupLifecyclePolicyOperationOptions) ToOData 

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

func (DeleteGroupLifecyclePolicyOperationOptions) ToQuery 

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

type DeleteGroupLifecyclePolicyOperationResponse 

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

type GetGroupLifecyclePoliciesCountOperationOptions 

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

func DefaultGetGroupLifecyclePoliciesCountOperationOptions 

func DefaultGetGroupLifecyclePoliciesCountOperationOptions() GetGroupLifecyclePoliciesCountOperationOptions

func (GetGroupLifecyclePoliciesCountOperationOptions) ToHeaders 

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

func (GetGroupLifecyclePoliciesCountOperationOptions) ToOData 

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

func (GetGroupLifecyclePoliciesCountOperationOptions) ToQuery 

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

type GetGroupLifecyclePoliciesCountOperationResponse 

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

type GetGroupLifecyclePolicyOperationOptions 

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

func DefaultGetGroupLifecyclePolicyOperationOptions 

func DefaultGetGroupLifecyclePolicyOperationOptions() GetGroupLifecyclePolicyOperationOptions

func (GetGroupLifecyclePolicyOperationOptions) ToHeaders 

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

func (GetGroupLifecyclePolicyOperationOptions) ToOData 

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

func (GetGroupLifecyclePolicyOperationOptions) ToQuery 

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

type GetGroupLifecyclePolicyOperationResponse 

type GetGroupLifecyclePolicyOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.GroupLifecyclePolicy
}

type GroupLifecyclePolicyClient 

type GroupLifecyclePolicyClient struct {
	Client *msgraph.Client
}

func NewGroupLifecyclePolicyClientWithBaseURI 

func NewGroupLifecyclePolicyClientWithBaseURI(sdkApi sdkEnv.Api) (*GroupLifecyclePolicyClient, error)

func (GroupLifecyclePolicyClient) AddGroupLifecyclePolicyGroup 

func (c GroupLifecyclePolicyClient) AddGroupLifecyclePolicyGroup(ctx context.Context, id stable.GroupIdGroupLifecyclePolicyId, input AddGroupLifecyclePolicyGroupRequest, options AddGroupLifecyclePolicyGroupOperationOptions) (result AddGroupLifecyclePolicyGroupOperationResponse, err error)

AddGroupLifecyclePolicyGroup - Invoke action addGroup. Adds specific groups to a lifecycle policy. This action limits the group lifecycle policy to a set of groups only if the managedGroupTypes property of groupLifecyclePolicy is set to Selected.

func (GroupLifecyclePolicyClient) CreateGroupLifecyclePolicy 

func (c GroupLifecyclePolicyClient) CreateGroupLifecyclePolicy(ctx context.Context, id stable.GroupId, input stable.GroupLifecyclePolicy, options CreateGroupLifecyclePolicyOperationOptions) (result CreateGroupLifecyclePolicyOperationResponse, err error)

CreateGroupLifecyclePolicy - Create new navigation property to groupLifecyclePolicies for groups

func (GroupLifecyclePolicyClient) DeleteGroupLifecyclePolicy 

func (c GroupLifecyclePolicyClient) DeleteGroupLifecyclePolicy(ctx context.Context, id stable.GroupIdGroupLifecyclePolicyId, options DeleteGroupLifecyclePolicyOperationOptions) (result DeleteGroupLifecyclePolicyOperationResponse, err error)

DeleteGroupLifecyclePolicy - Delete navigation property groupLifecyclePolicies for groups

func (GroupLifecyclePolicyClient) GetGroupLifecyclePoliciesCount 

func (c GroupLifecyclePolicyClient) GetGroupLifecyclePoliciesCount(ctx context.Context, id stable.GroupId, options GetGroupLifecyclePoliciesCountOperationOptions) (result GetGroupLifecyclePoliciesCountOperationResponse, err error)

GetGroupLifecyclePoliciesCount - Get the number of the resource

func (GroupLifecyclePolicyClient) GetGroupLifecyclePolicy 

func (c GroupLifecyclePolicyClient) GetGroupLifecyclePolicy(ctx context.Context, id stable.GroupIdGroupLifecyclePolicyId, options GetGroupLifecyclePolicyOperationOptions) (result GetGroupLifecyclePolicyOperationResponse, err error)

GetGroupLifecyclePolicy - Get groupLifecyclePolicies from groups. The collection of lifecycle policies for this group. Read-only. Nullable.

func (GroupLifecyclePolicyClient) ListGroupLifecyclePolicies 

func (c GroupLifecyclePolicyClient) ListGroupLifecyclePolicies(ctx context.Context, id stable.GroupId, options ListGroupLifecyclePoliciesOperationOptions) (result ListGroupLifecyclePoliciesOperationResponse, err error)

ListGroupLifecyclePolicies - List groupLifecyclePolicies. Retrieves a list of groupLifecyclePolicy objects to which a group belongs.

func (GroupLifecyclePolicyClient) ListGroupLifecyclePoliciesComplete 

func (c GroupLifecyclePolicyClient) ListGroupLifecyclePoliciesComplete(ctx context.Context, id stable.GroupId, options ListGroupLifecyclePoliciesOperationOptions) (ListGroupLifecyclePoliciesCompleteResult, error)

ListGroupLifecyclePoliciesComplete retrieves all the results into a single object

func (GroupLifecyclePolicyClient) ListGroupLifecyclePoliciesCompleteMatchingPredicate 

func (c GroupLifecyclePolicyClient) ListGroupLifecyclePoliciesCompleteMatchingPredicate(ctx context.Context, id stable.GroupId, options ListGroupLifecyclePoliciesOperationOptions, predicate GroupLifecyclePolicyOperationPredicate) (result ListGroupLifecyclePoliciesCompleteResult, err error)

ListGroupLifecyclePoliciesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (GroupLifecyclePolicyClient) RemoveGroupLifecyclePolicyGroup 

func (c GroupLifecyclePolicyClient) RemoveGroupLifecyclePolicyGroup(ctx context.Context, id stable.GroupIdGroupLifecyclePolicyId, input RemoveGroupLifecyclePolicyGroupRequest, options RemoveGroupLifecyclePolicyGroupOperationOptions) (result RemoveGroupLifecyclePolicyGroupOperationResponse, err error)

RemoveGroupLifecyclePolicyGroup - Invoke action removeGroup. Removes a group from a lifecycle policy.

func (GroupLifecyclePolicyClient) UpdateGroupLifecyclePolicy 

func (c GroupLifecyclePolicyClient) UpdateGroupLifecyclePolicy(ctx context.Context, id stable.GroupIdGroupLifecyclePolicyId, input stable.GroupLifecyclePolicy, options UpdateGroupLifecyclePolicyOperationOptions) (result UpdateGroupLifecyclePolicyOperationResponse, err error)

UpdateGroupLifecyclePolicy - Update the navigation property groupLifecyclePolicies in groups

type GroupLifecyclePolicyOperationPredicate 

type GroupLifecyclePolicyOperationPredicate struct {
}

func (GroupLifecyclePolicyOperationPredicate) Matches 

func (p GroupLifecyclePolicyOperationPredicate) Matches(input stable.GroupLifecyclePolicy) bool

type ListGroupLifecyclePoliciesCompleteResult 

type ListGroupLifecyclePoliciesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.GroupLifecyclePolicy
}

type ListGroupLifecyclePoliciesCustomPager 

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

type ListGroupLifecyclePoliciesOperationOptions 

type ListGroupLifecyclePoliciesOperationOptions 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 DefaultListGroupLifecyclePoliciesOperationOptions 

func DefaultListGroupLifecyclePoliciesOperationOptions() ListGroupLifecyclePoliciesOperationOptions

func (ListGroupLifecyclePoliciesOperationOptions) ToHeaders 

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

func (ListGroupLifecyclePoliciesOperationOptions) ToOData 

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

func (ListGroupLifecyclePoliciesOperationOptions) ToQuery 

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

type ListGroupLifecyclePoliciesOperationResponse 

type ListGroupLifecyclePoliciesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.GroupLifecyclePolicy
}

type RemoveGroupLifecyclePolicyGroupOperationOptions 

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

func DefaultRemoveGroupLifecyclePolicyGroupOperationOptions 

func DefaultRemoveGroupLifecyclePolicyGroupOperationOptions() RemoveGroupLifecyclePolicyGroupOperationOptions

func (RemoveGroupLifecyclePolicyGroupOperationOptions) ToHeaders 

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

func (RemoveGroupLifecyclePolicyGroupOperationOptions) ToOData 

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

func (RemoveGroupLifecyclePolicyGroupOperationOptions) ToQuery 

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

type RemoveGroupLifecyclePolicyGroupOperationResponse 

type RemoveGroupLifecyclePolicyGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RemoveGroupLifecyclePolicyGroupResult
}

type RemoveGroupLifecyclePolicyGroupRequest 

type RemoveGroupLifecyclePolicyGroupRequest struct {
	GroupId *string `json:"groupId,omitempty"`
}

type RemoveGroupLifecyclePolicyGroupResult 

type RemoveGroupLifecyclePolicyGroupResult struct {
	Value *bool `json:"value,omitempty"`
}

type UpdateGroupLifecyclePolicyOperationOptions 

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

func DefaultUpdateGroupLifecyclePolicyOperationOptions 

func DefaultUpdateGroupLifecyclePolicyOperationOptions() UpdateGroupLifecyclePolicyOperationOptions

func (UpdateGroupLifecyclePolicyOperationOptions) ToHeaders 

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

func (UpdateGroupLifecyclePolicyOperationOptions) ToOData 

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

func (UpdateGroupLifecyclePolicyOperationOptions) ToQuery 

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

type UpdateGroupLifecyclePolicyOperationResponse 

type UpdateGroupLifecyclePolicyOperationResponse 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.