deleteditem

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: 10 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/directory/beta/deleteditem Documentation

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

Client Initialization

client := deleteditem.NewDeletedItemClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: DeletedItemClient.CheckDeletedItemMemberGroups

ctx := context.TODO()
id := deleteditem.NewDirectoryDeletedItemID("directoryObjectId")

payload := deleteditem.CheckDeletedItemMemberGroupsRequest{
	// ...
}


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

Example Usage: DeletedItemClient.CheckDeletedItemMemberObjects

ctx := context.TODO()
id := deleteditem.NewDirectoryDeletedItemID("directoryObjectId")

payload := deleteditem.CheckDeletedItemMemberObjectsRequest{
	// ...
}


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

Example Usage: DeletedItemClient.DeleteDeletedItem

ctx := context.TODO()
id := deleteditem.NewDirectoryDeletedItemID("directoryObjectId")

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

Example Usage: DeletedItemClient.GetDeletedItem

ctx := context.TODO()
id := deleteditem.NewDirectoryDeletedItemID("directoryObjectId")

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

Example Usage: DeletedItemClient.GetDeletedItemMemberGroups

ctx := context.TODO()
id := deleteditem.NewDirectoryDeletedItemID("directoryObjectId")

payload := deleteditem.GetDeletedItemMemberGroupsRequest{
	// ...
}


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

Example Usage: DeletedItemClient.GetDeletedItemMemberObjects

ctx := context.TODO()
id := deleteditem.NewDirectoryDeletedItemID("directoryObjectId")

payload := deleteditem.GetDeletedItemMemberObjectsRequest{
	// ...
}


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

Example Usage: DeletedItemClient.GetDeletedItemsByIds

ctx := context.TODO()

payload := deleteditem.GetDeletedItemsByIdsRequest{
	// ...
}


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

Example Usage: DeletedItemClient.GetDeletedItemsCount

ctx := context.TODO()


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

Example Usage: DeletedItemClient.ListDeletedItems

ctx := context.TODO()


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

Example Usage: DeletedItemClient.RestoreDeletedItem

ctx := context.TODO()
id := deleteditem.NewDirectoryDeletedItemID("directoryObjectId")

payload := deleteditem.RestoreDeletedItemRequest{
	// ...
}


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

Example Usage: DeletedItemClient.ValidateDeletedItemsProperties

ctx := context.TODO()

payload := deleteditem.ValidateDeletedItemsPropertiesRequest{
	// ...
}


read, err := client.ValidateDeletedItemsProperties(ctx, payload, deleteditem.DefaultValidateDeletedItemsPropertiesOperationOptions())
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 CheckDeletedItemMemberGroupsCompleteResult

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

type CheckDeletedItemMemberGroupsCustomPager

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

type CheckDeletedItemMemberGroupsOperationOptions

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

func DefaultCheckDeletedItemMemberGroupsOperationOptions

func DefaultCheckDeletedItemMemberGroupsOperationOptions() CheckDeletedItemMemberGroupsOperationOptions

func (CheckDeletedItemMemberGroupsOperationOptions) ToHeaders

func (CheckDeletedItemMemberGroupsOperationOptions) ToOData

func (CheckDeletedItemMemberGroupsOperationOptions) ToQuery

type CheckDeletedItemMemberGroupsOperationResponse

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

type CheckDeletedItemMemberGroupsRequest

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

type CheckDeletedItemMemberObjectsCompleteResult

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

type CheckDeletedItemMemberObjectsCustomPager

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

type CheckDeletedItemMemberObjectsOperationOptions

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

func DefaultCheckDeletedItemMemberObjectsOperationOptions

func DefaultCheckDeletedItemMemberObjectsOperationOptions() CheckDeletedItemMemberObjectsOperationOptions

func (CheckDeletedItemMemberObjectsOperationOptions) ToHeaders

func (CheckDeletedItemMemberObjectsOperationOptions) ToOData

func (CheckDeletedItemMemberObjectsOperationOptions) ToQuery

type CheckDeletedItemMemberObjectsOperationResponse

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

type CheckDeletedItemMemberObjectsRequest

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

type DeleteDeletedItemOperationOptions

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

func DefaultDeleteDeletedItemOperationOptions

func DefaultDeleteDeletedItemOperationOptions() DeleteDeletedItemOperationOptions

func (DeleteDeletedItemOperationOptions) ToHeaders

func (DeleteDeletedItemOperationOptions) ToOData

func (DeleteDeletedItemOperationOptions) ToQuery

type DeleteDeletedItemOperationResponse

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

type DeletedItemClient

type DeletedItemClient struct {
	Client *msgraph.Client
}

func NewDeletedItemClientWithBaseURI

func NewDeletedItemClientWithBaseURI(sdkApi sdkEnv.Api) (*DeletedItemClient, error)

func (DeletedItemClient) CheckDeletedItemMemberGroups

CheckDeletedItemMemberGroups - 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 (DeletedItemClient) CheckDeletedItemMemberGroupsComplete

CheckDeletedItemMemberGroupsComplete retrieves all the results into a single object

func (DeletedItemClient) CheckDeletedItemMemberObjects

CheckDeletedItemMemberObjects - Invoke action checkMemberObjects

func (DeletedItemClient) CheckDeletedItemMemberObjectsComplete

CheckDeletedItemMemberObjectsComplete retrieves all the results into a single object

func (DeletedItemClient) DeleteDeletedItem

DeleteDeletedItem - Delete navigation property deletedItems for directory

func (DeletedItemClient) GetDeletedItem

GetDeletedItem - Get deletedItems from directory. Recently deleted items. Read-only. Nullable.

func (DeletedItemClient) GetDeletedItemMemberGroups

GetDeletedItemMemberGroups - 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 (DeletedItemClient) GetDeletedItemMemberGroupsComplete

GetDeletedItemMemberGroupsComplete retrieves all the results into a single object

func (DeletedItemClient) GetDeletedItemMemberObjects

GetDeletedItemMemberObjects - Invoke action getMemberObjects

func (DeletedItemClient) GetDeletedItemMemberObjectsComplete

GetDeletedItemMemberObjectsComplete retrieves all the results into a single object

func (DeletedItemClient) GetDeletedItemsByIds

GetDeletedItemsByIds - Invoke action getByIds. Return the directory objects specified in a list of IDs. Some common uses for this function are to

func (DeletedItemClient) GetDeletedItemsByIdsComplete

GetDeletedItemsByIdsComplete retrieves all the results into a single object

func (DeletedItemClient) GetDeletedItemsByIdsCompleteMatchingPredicate

GetDeletedItemsByIdsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DeletedItemClient) GetDeletedItemsCount

GetDeletedItemsCount - Get the number of the resource

func (DeletedItemClient) ListDeletedItems

ListDeletedItems - Get deletedItems from directory. Recently deleted items. Read-only. Nullable.

func (DeletedItemClient) ListDeletedItemsComplete

ListDeletedItemsComplete retrieves all the results into a single object

func (DeletedItemClient) ListDeletedItemsCompleteMatchingPredicate

func (c DeletedItemClient) ListDeletedItemsCompleteMatchingPredicate(ctx context.Context, options ListDeletedItemsOperationOptions, predicate DirectoryObjectOperationPredicate) (result ListDeletedItemsCompleteResult, err error)

ListDeletedItemsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DeletedItemClient) RestoreDeletedItem

RestoreDeletedItem - Invoke action restore. Restore a recently deleted application, externalUserProfile, group, pendingExternalUserProfile, servicePrincipal, administrative unit, or user object from deleted items. If an item was accidentally deleted, you can fully restore the item. This isn't applicable to security groups, which are deleted permanently. 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 (DeletedItemClient) ValidateDeletedItemsProperties

ValidateDeletedItemsProperties - 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. For validating properties of an existing group, use the validateProperties function for groups. The following 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 the mail nickname is unique This API returns with the first failure encountered. If one or more properties fail multiple validations, only the property with 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.

type DirectoryObjectOperationPredicate

type DirectoryObjectOperationPredicate struct {
}

func (DirectoryObjectOperationPredicate) Matches

type GetDeletedItemMemberGroupsCompleteResult

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

type GetDeletedItemMemberGroupsCustomPager

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

type GetDeletedItemMemberGroupsOperationOptions

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

func DefaultGetDeletedItemMemberGroupsOperationOptions

func DefaultGetDeletedItemMemberGroupsOperationOptions() GetDeletedItemMemberGroupsOperationOptions

func (GetDeletedItemMemberGroupsOperationOptions) ToHeaders

func (GetDeletedItemMemberGroupsOperationOptions) ToOData

func (GetDeletedItemMemberGroupsOperationOptions) ToQuery

type GetDeletedItemMemberGroupsOperationResponse

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

type GetDeletedItemMemberGroupsRequest

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

type GetDeletedItemMemberObjectsCompleteResult

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

type GetDeletedItemMemberObjectsCustomPager

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

type GetDeletedItemMemberObjectsOperationOptions

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

func DefaultGetDeletedItemMemberObjectsOperationOptions

func DefaultGetDeletedItemMemberObjectsOperationOptions() GetDeletedItemMemberObjectsOperationOptions

func (GetDeletedItemMemberObjectsOperationOptions) ToHeaders

func (GetDeletedItemMemberObjectsOperationOptions) ToOData

func (GetDeletedItemMemberObjectsOperationOptions) ToQuery

type GetDeletedItemMemberObjectsOperationResponse

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

type GetDeletedItemMemberObjectsRequest

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

type GetDeletedItemOperationOptions

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

func DefaultGetDeletedItemOperationOptions

func DefaultGetDeletedItemOperationOptions() GetDeletedItemOperationOptions

func (GetDeletedItemOperationOptions) ToHeaders

func (GetDeletedItemOperationOptions) ToOData

func (GetDeletedItemOperationOptions) ToQuery

type GetDeletedItemOperationResponse

type GetDeletedItemOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        beta.DirectoryObject
}

type GetDeletedItemsByIdsCompleteResult

type GetDeletedItemsByIdsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.DirectoryObject
}

type GetDeletedItemsByIdsCustomPager

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

type GetDeletedItemsByIdsOperationOptions

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

func DefaultGetDeletedItemsByIdsOperationOptions

func DefaultGetDeletedItemsByIdsOperationOptions() GetDeletedItemsByIdsOperationOptions

func (GetDeletedItemsByIdsOperationOptions) ToHeaders

func (GetDeletedItemsByIdsOperationOptions) ToOData

func (GetDeletedItemsByIdsOperationOptions) ToQuery

type GetDeletedItemsByIdsOperationResponse

type GetDeletedItemsByIdsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.DirectoryObject
}

type GetDeletedItemsByIdsRequest

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

type GetDeletedItemsCountOperationOptions

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

func DefaultGetDeletedItemsCountOperationOptions

func DefaultGetDeletedItemsCountOperationOptions() GetDeletedItemsCountOperationOptions

func (GetDeletedItemsCountOperationOptions) ToHeaders

func (GetDeletedItemsCountOperationOptions) ToOData

func (GetDeletedItemsCountOperationOptions) ToQuery

type GetDeletedItemsCountOperationResponse

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

type ListDeletedItemsCompleteResult

type ListDeletedItemsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.DirectoryObject
}

type ListDeletedItemsCustomPager

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

type ListDeletedItemsOperationOptions

type ListDeletedItemsOperationOptions 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 DefaultListDeletedItemsOperationOptions

func DefaultListDeletedItemsOperationOptions() ListDeletedItemsOperationOptions

func (ListDeletedItemsOperationOptions) ToHeaders

func (ListDeletedItemsOperationOptions) ToOData

func (ListDeletedItemsOperationOptions) ToQuery

type ListDeletedItemsOperationResponse

type ListDeletedItemsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.DirectoryObject
}

type RestoreDeletedItemOperationOptions

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

func DefaultRestoreDeletedItemOperationOptions

func DefaultRestoreDeletedItemOperationOptions() RestoreDeletedItemOperationOptions

func (RestoreDeletedItemOperationOptions) ToHeaders

func (RestoreDeletedItemOperationOptions) ToOData

func (RestoreDeletedItemOperationOptions) ToQuery

type RestoreDeletedItemOperationResponse

type RestoreDeletedItemOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        beta.DirectoryObject
}

type RestoreDeletedItemRequest

type RestoreDeletedItemRequest struct {
	AutoReconcileProxyConflict nullable.Type[bool] `json:"autoReconcileProxyConflict,omitempty"`
}

type ValidateDeletedItemsPropertiesOperationOptions

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

func DefaultValidateDeletedItemsPropertiesOperationOptions

func DefaultValidateDeletedItemsPropertiesOperationOptions() ValidateDeletedItemsPropertiesOperationOptions

func (ValidateDeletedItemsPropertiesOperationOptions) ToHeaders

func (ValidateDeletedItemsPropertiesOperationOptions) ToOData

func (ValidateDeletedItemsPropertiesOperationOptions) ToQuery

type ValidateDeletedItemsPropertiesOperationResponse

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

type ValidateDeletedItemsPropertiesRequest

type ValidateDeletedItemsPropertiesRequest 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"`
}

Jump to

Keyboard shortcuts

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