pendingaccessreviewinstance

package
v0.20241209.1115630 Latest Latest
Warning

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

Go to latest
Published: Dec 9, 2024 License: MPL-2.0 Imports: 9 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/users/beta/pendingaccessreviewinstance Documentation

The pendingaccessreviewinstance SDK allows for interaction with Microsoft Graph users (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/users/beta/pendingaccessreviewinstance"

Client Initialization

client := pendingaccessreviewinstance.NewPendingAccessReviewInstanceClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: PendingAccessReviewInstanceClient.AcceptPendingAccessReviewInstanceRecommendations

ctx := context.TODO()
id := pendingaccessreviewinstance.NewUserIdPendingAccessReviewInstanceID("userId", "accessReviewInstanceId")

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

Example Usage: PendingAccessReviewInstanceClient.CreatePendingAccessReviewInstance

ctx := context.TODO()
id := pendingaccessreviewinstance.NewUserID("userId")

payload := pendingaccessreviewinstance.AccessReviewInstance{
	// ...
}


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

Example Usage: PendingAccessReviewInstanceClient.CreatePendingAccessReviewInstanceApplyDecision

ctx := context.TODO()
id := pendingaccessreviewinstance.NewUserIdPendingAccessReviewInstanceID("userId", "accessReviewInstanceId")

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

Example Usage: PendingAccessReviewInstanceClient.CreatePendingAccessReviewInstanceBatchRecordDecision

ctx := context.TODO()
id := pendingaccessreviewinstance.NewUserIdPendingAccessReviewInstanceID("userId", "accessReviewInstanceId")

payload := pendingaccessreviewinstance.CreatePendingAccessReviewInstanceBatchRecordDecisionRequest{
	// ...
}


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

Example Usage: PendingAccessReviewInstanceClient.DeletePendingAccessReviewInstance

ctx := context.TODO()
id := pendingaccessreviewinstance.NewUserIdPendingAccessReviewInstanceID("userId", "accessReviewInstanceId")

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

Example Usage: PendingAccessReviewInstanceClient.GetPendingAccessReviewInstance

ctx := context.TODO()
id := pendingaccessreviewinstance.NewUserIdPendingAccessReviewInstanceID("userId", "accessReviewInstanceId")

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

Example Usage: PendingAccessReviewInstanceClient.GetPendingAccessReviewInstancesCount

ctx := context.TODO()
id := pendingaccessreviewinstance.NewUserID("userId")

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

Example Usage: PendingAccessReviewInstanceClient.ListPendingAccessReviewInstances

ctx := context.TODO()
id := pendingaccessreviewinstance.NewUserID("userId")

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

Example Usage: PendingAccessReviewInstanceClient.ResetPendingAccessReviewInstanceDecisions

ctx := context.TODO()
id := pendingaccessreviewinstance.NewUserIdPendingAccessReviewInstanceID("userId", "accessReviewInstanceId")

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

Example Usage: PendingAccessReviewInstanceClient.SendPendingAccessReviewInstanceReminder

ctx := context.TODO()
id := pendingaccessreviewinstance.NewUserIdPendingAccessReviewInstanceID("userId", "accessReviewInstanceId")

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

Example Usage: PendingAccessReviewInstanceClient.StopPendingAccessReviewInstance

ctx := context.TODO()
id := pendingaccessreviewinstance.NewUserIdPendingAccessReviewInstanceID("userId", "accessReviewInstanceId")

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

Example Usage: PendingAccessReviewInstanceClient.StopPendingAccessReviewInstanceApplyDecisions

ctx := context.TODO()
id := pendingaccessreviewinstance.NewUserIdPendingAccessReviewInstanceID("userId", "accessReviewInstanceId")

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

Example Usage: PendingAccessReviewInstanceClient.UpdatePendingAccessReviewInstance

ctx := context.TODO()
id := pendingaccessreviewinstance.NewUserIdPendingAccessReviewInstanceID("userId", "accessReviewInstanceId")

payload := pendingaccessreviewinstance.AccessReviewInstance{
	// ...
}


read, err := client.UpdatePendingAccessReviewInstance(ctx, id, payload, pendingaccessreviewinstance.DefaultUpdatePendingAccessReviewInstanceOperationOptions())
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 AcceptPendingAccessReviewInstanceRecommendationsOperationOptions

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

func (AcceptPendingAccessReviewInstanceRecommendationsOperationOptions) ToHeaders

func (AcceptPendingAccessReviewInstanceRecommendationsOperationOptions) ToOData

func (AcceptPendingAccessReviewInstanceRecommendationsOperationOptions) ToQuery

type AcceptPendingAccessReviewInstanceRecommendationsOperationResponse

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

type AccessReviewInstanceOperationPredicate

type AccessReviewInstanceOperationPredicate struct {
}

func (AccessReviewInstanceOperationPredicate) Matches

type CreatePendingAccessReviewInstanceApplyDecisionOperationOptions

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

func (CreatePendingAccessReviewInstanceApplyDecisionOperationOptions) ToHeaders

func (CreatePendingAccessReviewInstanceApplyDecisionOperationOptions) ToOData

func (CreatePendingAccessReviewInstanceApplyDecisionOperationOptions) ToQuery

type CreatePendingAccessReviewInstanceApplyDecisionOperationResponse

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

type CreatePendingAccessReviewInstanceBatchRecordDecisionOperationOptions

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

func (CreatePendingAccessReviewInstanceBatchRecordDecisionOperationOptions) ToHeaders

func (CreatePendingAccessReviewInstanceBatchRecordDecisionOperationOptions) ToOData

func (CreatePendingAccessReviewInstanceBatchRecordDecisionOperationOptions) ToQuery

type CreatePendingAccessReviewInstanceBatchRecordDecisionOperationResponse

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

type CreatePendingAccessReviewInstanceBatchRecordDecisionRequest

type CreatePendingAccessReviewInstanceBatchRecordDecisionRequest struct {
	Decision      nullable.Type[string] `json:"decision,omitempty"`
	Justification nullable.Type[string] `json:"justification,omitempty"`
	PrincipalId   nullable.Type[string] `json:"principalId,omitempty"`
	ResourceId    nullable.Type[string] `json:"resourceId,omitempty"`
}

type CreatePendingAccessReviewInstanceOperationOptions

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

func DefaultCreatePendingAccessReviewInstanceOperationOptions

func DefaultCreatePendingAccessReviewInstanceOperationOptions() CreatePendingAccessReviewInstanceOperationOptions

func (CreatePendingAccessReviewInstanceOperationOptions) ToHeaders

func (CreatePendingAccessReviewInstanceOperationOptions) ToOData

func (CreatePendingAccessReviewInstanceOperationOptions) ToQuery

type CreatePendingAccessReviewInstanceOperationResponse

type CreatePendingAccessReviewInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.AccessReviewInstance
}

type DeletePendingAccessReviewInstanceOperationOptions

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

func DefaultDeletePendingAccessReviewInstanceOperationOptions

func DefaultDeletePendingAccessReviewInstanceOperationOptions() DeletePendingAccessReviewInstanceOperationOptions

func (DeletePendingAccessReviewInstanceOperationOptions) ToHeaders

func (DeletePendingAccessReviewInstanceOperationOptions) ToOData

func (DeletePendingAccessReviewInstanceOperationOptions) ToQuery

type DeletePendingAccessReviewInstanceOperationResponse

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

type GetPendingAccessReviewInstanceOperationOptions

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

func DefaultGetPendingAccessReviewInstanceOperationOptions

func DefaultGetPendingAccessReviewInstanceOperationOptions() GetPendingAccessReviewInstanceOperationOptions

func (GetPendingAccessReviewInstanceOperationOptions) ToHeaders

func (GetPendingAccessReviewInstanceOperationOptions) ToOData

func (GetPendingAccessReviewInstanceOperationOptions) ToQuery

type GetPendingAccessReviewInstanceOperationResponse

type GetPendingAccessReviewInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.AccessReviewInstance
}

type GetPendingAccessReviewInstancesCountOperationOptions

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

func DefaultGetPendingAccessReviewInstancesCountOperationOptions

func DefaultGetPendingAccessReviewInstancesCountOperationOptions() GetPendingAccessReviewInstancesCountOperationOptions

func (GetPendingAccessReviewInstancesCountOperationOptions) ToHeaders

func (GetPendingAccessReviewInstancesCountOperationOptions) ToOData

func (GetPendingAccessReviewInstancesCountOperationOptions) ToQuery

type GetPendingAccessReviewInstancesCountOperationResponse

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

type ListPendingAccessReviewInstancesCompleteResult

type ListPendingAccessReviewInstancesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.AccessReviewInstance
}

type ListPendingAccessReviewInstancesCustomPager

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

type ListPendingAccessReviewInstancesOperationOptions

type ListPendingAccessReviewInstancesOperationOptions 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 DefaultListPendingAccessReviewInstancesOperationOptions

func DefaultListPendingAccessReviewInstancesOperationOptions() ListPendingAccessReviewInstancesOperationOptions

func (ListPendingAccessReviewInstancesOperationOptions) ToHeaders

func (ListPendingAccessReviewInstancesOperationOptions) ToOData

func (ListPendingAccessReviewInstancesOperationOptions) ToQuery

type ListPendingAccessReviewInstancesOperationResponse

type ListPendingAccessReviewInstancesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.AccessReviewInstance
}

type PendingAccessReviewInstanceClient

type PendingAccessReviewInstanceClient struct {
	Client *msgraph.Client
}

func NewPendingAccessReviewInstanceClientWithBaseURI

func NewPendingAccessReviewInstanceClientWithBaseURI(sdkApi sdkEnv.Api) (*PendingAccessReviewInstanceClient, error)

func (PendingAccessReviewInstanceClient) AcceptPendingAccessReviewInstanceRecommendations

AcceptPendingAccessReviewInstanceRecommendations - Invoke action acceptRecommendations. Allows the acceptance of recommendations on all accessReviewInstanceDecisionItem objects that haven't been reviewed for an accessReviewInstance object for which the calling user is a reviewer. Recommendations are generated if recommendationsEnabled is true on the accessReviewScheduleDefinition object. If there isn't a recommendation on an accessReviewInstanceDecisionItem object no decision will be recorded.

func (PendingAccessReviewInstanceClient) CreatePendingAccessReviewInstance

CreatePendingAccessReviewInstance - Create new navigation property to pendingAccessReviewInstances for users

func (PendingAccessReviewInstanceClient) CreatePendingAccessReviewInstanceApplyDecision

CreatePendingAccessReviewInstanceApplyDecision - Invoke action applyDecisions. Apply review decisions on an accessReviewInstance if the decisions were not applied automatically because the autoApplyDecisionsEnabled property is false in the review's accessReviewScheduleSettings. The status of the accessReviewInstance must be Completed to call this method.

func (PendingAccessReviewInstanceClient) CreatePendingAccessReviewInstanceBatchRecordDecision

CreatePendingAccessReviewInstanceBatchRecordDecision - Invoke action batchRecordDecisions. Enables reviewers to review all accessReviewInstanceDecisionItem objects in batches by using principalId, resourceId, or neither.

func (PendingAccessReviewInstanceClient) DeletePendingAccessReviewInstance

DeletePendingAccessReviewInstance - Delete navigation property pendingAccessReviewInstances for users

func (PendingAccessReviewInstanceClient) GetPendingAccessReviewInstance

GetPendingAccessReviewInstance - Get pendingAccessReviewInstances from users. Navigation property to get a list of access reviews pending approval by the reviewer.

func (PendingAccessReviewInstanceClient) GetPendingAccessReviewInstancesCount

GetPendingAccessReviewInstancesCount - Get the number of the resource

func (PendingAccessReviewInstanceClient) ListPendingAccessReviewInstances

ListPendingAccessReviewInstances - Get pendingAccessReviewInstances from users. Navigation property to get a list of access reviews pending approval by the reviewer.

func (PendingAccessReviewInstanceClient) ListPendingAccessReviewInstancesComplete

ListPendingAccessReviewInstancesComplete retrieves all the results into a single object

func (PendingAccessReviewInstanceClient) ListPendingAccessReviewInstancesCompleteMatchingPredicate

ListPendingAccessReviewInstancesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PendingAccessReviewInstanceClient) ResetPendingAccessReviewInstanceDecisions

ResetPendingAccessReviewInstanceDecisions - Invoke action resetDecisions. Resets decisions of all accessReviewInstanceDecisionItem objects on an accessReviewInstance to notReviewed.

func (PendingAccessReviewInstanceClient) SendPendingAccessReviewInstanceReminder

SendPendingAccessReviewInstanceReminder - Invoke action sendReminder. Send a reminder to the reviewers of a currently active accessReviewInstance.

func (PendingAccessReviewInstanceClient) StopPendingAccessReviewInstance

StopPendingAccessReviewInstance - Invoke action stop. Stop a currently active accessReviewInstance. After the access review instance stops, the instance status will be Completed, the reviewers can no longer give input, and the access review decisions can be applied. Stopping an instance will not effect future instances. To prevent a recurring access review from starting future instances, update the schedule definition to change its scheduled end date.

func (PendingAccessReviewInstanceClient) StopPendingAccessReviewInstanceApplyDecisions

StopPendingAccessReviewInstanceApplyDecisions - Invoke action stopApplyDecisions

func (PendingAccessReviewInstanceClient) UpdatePendingAccessReviewInstance

UpdatePendingAccessReviewInstance - Update the navigation property pendingAccessReviewInstances in users

type ResetPendingAccessReviewInstanceDecisionsOperationOptions

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

func (ResetPendingAccessReviewInstanceDecisionsOperationOptions) ToHeaders

func (ResetPendingAccessReviewInstanceDecisionsOperationOptions) ToOData

func (ResetPendingAccessReviewInstanceDecisionsOperationOptions) ToQuery

type ResetPendingAccessReviewInstanceDecisionsOperationResponse

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

type SendPendingAccessReviewInstanceReminderOperationOptions

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

func (SendPendingAccessReviewInstanceReminderOperationOptions) ToHeaders

func (SendPendingAccessReviewInstanceReminderOperationOptions) ToOData

func (SendPendingAccessReviewInstanceReminderOperationOptions) ToQuery

type SendPendingAccessReviewInstanceReminderOperationResponse

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

type StopPendingAccessReviewInstanceApplyDecisionsOperationOptions

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

func (StopPendingAccessReviewInstanceApplyDecisionsOperationOptions) ToHeaders

func (StopPendingAccessReviewInstanceApplyDecisionsOperationOptions) ToOData

func (StopPendingAccessReviewInstanceApplyDecisionsOperationOptions) ToQuery

type StopPendingAccessReviewInstanceApplyDecisionsOperationResponse

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

type StopPendingAccessReviewInstanceOperationOptions

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

func DefaultStopPendingAccessReviewInstanceOperationOptions

func DefaultStopPendingAccessReviewInstanceOperationOptions() StopPendingAccessReviewInstanceOperationOptions

func (StopPendingAccessReviewInstanceOperationOptions) ToHeaders

func (StopPendingAccessReviewInstanceOperationOptions) ToOData

func (StopPendingAccessReviewInstanceOperationOptions) ToQuery

type StopPendingAccessReviewInstanceOperationResponse

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

type UpdatePendingAccessReviewInstanceOperationOptions

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

func DefaultUpdatePendingAccessReviewInstanceOperationOptions

func DefaultUpdatePendingAccessReviewInstanceOperationOptions() UpdatePendingAccessReviewInstanceOperationOptions

func (UpdatePendingAccessReviewInstanceOperationOptions) ToHeaders

func (UpdatePendingAccessReviewInstanceOperationOptions) ToOData

func (UpdatePendingAccessReviewInstanceOperationOptions) ToQuery

type UpdatePendingAccessReviewInstanceOperationResponse

type UpdatePendingAccessReviewInstanceOperationResponse 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