impactedresource

package
v0.20241126.2320 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := impactedresource.NewImpactedResourceClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: ImpactedResourceClient.CreateImpactedResource

ctx := context.TODO()

payload := impactedresource.ImpactedResource{
	// ...
}


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

Example Usage: ImpactedResourceClient.CreateImpactedResourceComplete

ctx := context.TODO()
id := impactedresource.NewDirectoryImpactedResourceID("impactedResourceId")

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

Example Usage: ImpactedResourceClient.CreateImpactedResourcePostpone

ctx := context.TODO()
id := impactedresource.NewDirectoryImpactedResourceID("impactedResourceId")

payload := impactedresource.CreateImpactedResourcePostponeRequest{
	// ...
}


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

Example Usage: ImpactedResourceClient.CreateImpactedResourceReactivate

ctx := context.TODO()
id := impactedresource.NewDirectoryImpactedResourceID("impactedResourceId")

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

Example Usage: ImpactedResourceClient.DeleteImpactedResource

ctx := context.TODO()
id := impactedresource.NewDirectoryImpactedResourceID("impactedResourceId")

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

Example Usage: ImpactedResourceClient.DismissImpactedResource

ctx := context.TODO()
id := impactedresource.NewDirectoryImpactedResourceID("impactedResourceId")

payload := impactedresource.DismissImpactedResourceRequest{
	// ...
}


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

Example Usage: ImpactedResourceClient.GetImpactedResource

ctx := context.TODO()
id := impactedresource.NewDirectoryImpactedResourceID("impactedResourceId")

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

Example Usage: ImpactedResourceClient.GetImpactedResourcesCount

ctx := context.TODO()


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

Example Usage: ImpactedResourceClient.ListImpactedResources

ctx := context.TODO()


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

Example Usage: ImpactedResourceClient.UpdateImpactedResource

ctx := context.TODO()
id := impactedresource.NewDirectoryImpactedResourceID("impactedResourceId")

payload := impactedresource.ImpactedResource{
	// ...
}


read, err := client.UpdateImpactedResource(ctx, id, payload, impactedresource.DefaultUpdateImpactedResourceOperationOptions())
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 CreateImpactedResourceCompleteOperationOptions

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

func DefaultCreateImpactedResourceCompleteOperationOptions

func DefaultCreateImpactedResourceCompleteOperationOptions() CreateImpactedResourceCompleteOperationOptions

func (CreateImpactedResourceCompleteOperationOptions) ToHeaders

func (CreateImpactedResourceCompleteOperationOptions) ToOData

func (CreateImpactedResourceCompleteOperationOptions) ToQuery

type CreateImpactedResourceCompleteOperationResponse

type CreateImpactedResourceCompleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.ImpactedResource
}

type CreateImpactedResourceOperationOptions

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

func DefaultCreateImpactedResourceOperationOptions

func DefaultCreateImpactedResourceOperationOptions() CreateImpactedResourceOperationOptions

func (CreateImpactedResourceOperationOptions) ToHeaders

func (CreateImpactedResourceOperationOptions) ToOData

func (CreateImpactedResourceOperationOptions) ToQuery

type CreateImpactedResourceOperationResponse

type CreateImpactedResourceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.ImpactedResource
}

type CreateImpactedResourcePostponeOperationOptions

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

func DefaultCreateImpactedResourcePostponeOperationOptions

func DefaultCreateImpactedResourcePostponeOperationOptions() CreateImpactedResourcePostponeOperationOptions

func (CreateImpactedResourcePostponeOperationOptions) ToHeaders

func (CreateImpactedResourcePostponeOperationOptions) ToOData

func (CreateImpactedResourcePostponeOperationOptions) ToQuery

type CreateImpactedResourcePostponeOperationResponse

type CreateImpactedResourcePostponeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.ImpactedResource
}

type CreateImpactedResourcePostponeRequest

type CreateImpactedResourcePostponeRequest struct {
	PostponeUntilDateTime *string `json:"postponeUntilDateTime,omitempty"`
}

type CreateImpactedResourceReactivateOperationOptions

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

func DefaultCreateImpactedResourceReactivateOperationOptions

func DefaultCreateImpactedResourceReactivateOperationOptions() CreateImpactedResourceReactivateOperationOptions

func (CreateImpactedResourceReactivateOperationOptions) ToHeaders

func (CreateImpactedResourceReactivateOperationOptions) ToOData

func (CreateImpactedResourceReactivateOperationOptions) ToQuery

type CreateImpactedResourceReactivateOperationResponse

type CreateImpactedResourceReactivateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.ImpactedResource
}

type DeleteImpactedResourceOperationOptions

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

func DefaultDeleteImpactedResourceOperationOptions

func DefaultDeleteImpactedResourceOperationOptions() DeleteImpactedResourceOperationOptions

func (DeleteImpactedResourceOperationOptions) ToHeaders

func (DeleteImpactedResourceOperationOptions) ToOData

func (DeleteImpactedResourceOperationOptions) ToQuery

type DeleteImpactedResourceOperationResponse

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

type DismissImpactedResourceOperationOptions

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

func DefaultDismissImpactedResourceOperationOptions

func DefaultDismissImpactedResourceOperationOptions() DismissImpactedResourceOperationOptions

func (DismissImpactedResourceOperationOptions) ToHeaders

func (DismissImpactedResourceOperationOptions) ToOData

func (DismissImpactedResourceOperationOptions) ToQuery

type DismissImpactedResourceOperationResponse

type DismissImpactedResourceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.ImpactedResource
}

type DismissImpactedResourceRequest

type DismissImpactedResourceRequest struct {
	DismissReason nullable.Type[string] `json:"dismissReason,omitempty"`
}

type GetImpactedResourceOperationOptions

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

func DefaultGetImpactedResourceOperationOptions

func DefaultGetImpactedResourceOperationOptions() GetImpactedResourceOperationOptions

func (GetImpactedResourceOperationOptions) ToHeaders

func (GetImpactedResourceOperationOptions) ToOData

func (GetImpactedResourceOperationOptions) ToQuery

type GetImpactedResourceOperationResponse

type GetImpactedResourceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.ImpactedResource
}

type GetImpactedResourcesCountOperationOptions

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

func DefaultGetImpactedResourcesCountOperationOptions

func DefaultGetImpactedResourcesCountOperationOptions() GetImpactedResourcesCountOperationOptions

func (GetImpactedResourcesCountOperationOptions) ToHeaders

func (GetImpactedResourcesCountOperationOptions) ToOData

func (GetImpactedResourcesCountOperationOptions) ToQuery

type GetImpactedResourcesCountOperationResponse

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

type ImpactedResourceClient

type ImpactedResourceClient struct {
	Client *msgraph.Client
}

func NewImpactedResourceClientWithBaseURI

func NewImpactedResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*ImpactedResourceClient, error)

func (ImpactedResourceClient) CreateImpactedResource

CreateImpactedResource - Create new navigation property to impactedResources for directory

func (ImpactedResourceClient) CreateImpactedResourceComplete

CreateImpactedResourceComplete - Invoke action complete. Complete an impactedResource object and update its status to completedByUser.

func (ImpactedResourceClient) CreateImpactedResourcePostpone

CreateImpactedResourcePostpone - Invoke action postpone. Postpone action on an impactedResource object to a specified future date and time by marking its status as postponed. On the specified date and time, Microsoft Entra ID will automatically mark the status of the impactedResource object to active.

func (ImpactedResourceClient) CreateImpactedResourceReactivate

CreateImpactedResourceReactivate - Invoke action reactivate. Reactivate an accidentally dismissed, completed, or postponed impactedResource object. This action updates the status of the resource to active. This method is relevant only if the status of the impactedResource object is dismissed, postponed, or completedByUser.

func (ImpactedResourceClient) DeleteImpactedResource

DeleteImpactedResource - Delete navigation property impactedResources for directory

func (ImpactedResourceClient) DismissImpactedResource

DismissImpactedResource - Invoke action dismiss. Dismiss an impactedResources object and update its status to dismissed.

func (ImpactedResourceClient) GetImpactedResource

GetImpactedResource - Get impactedResources from directory

func (ImpactedResourceClient) GetImpactedResourcesCount

GetImpactedResourcesCount - Get the number of the resource

func (ImpactedResourceClient) ListImpactedResources

ListImpactedResources - Get impactedResources from directory

func (ImpactedResourceClient) ListImpactedResourcesComplete

ListImpactedResourcesComplete retrieves all the results into a single object

func (ImpactedResourceClient) ListImpactedResourcesCompleteMatchingPredicate

func (c ImpactedResourceClient) ListImpactedResourcesCompleteMatchingPredicate(ctx context.Context, options ListImpactedResourcesOperationOptions, predicate ImpactedResourceOperationPredicate) (result ListImpactedResourcesCompleteResult, err error)

ListImpactedResourcesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ImpactedResourceClient) UpdateImpactedResource

UpdateImpactedResource - Update the navigation property impactedResources in directory

type ImpactedResourceOperationPredicate

type ImpactedResourceOperationPredicate struct {
}

func (ImpactedResourceOperationPredicate) Matches

type ListImpactedResourcesCompleteResult

type ListImpactedResourcesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.ImpactedResource
}

type ListImpactedResourcesCustomPager

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

type ListImpactedResourcesOperationOptions

type ListImpactedResourcesOperationOptions 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 DefaultListImpactedResourcesOperationOptions

func DefaultListImpactedResourcesOperationOptions() ListImpactedResourcesOperationOptions

func (ListImpactedResourcesOperationOptions) ToHeaders

func (ListImpactedResourcesOperationOptions) ToOData

func (ListImpactedResourcesOperationOptions) ToQuery

type ListImpactedResourcesOperationResponse

type ListImpactedResourcesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.ImpactedResource
}

type UpdateImpactedResourceOperationOptions

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

func DefaultUpdateImpactedResourceOperationOptions

func DefaultUpdateImpactedResourceOperationOptions() UpdateImpactedResourceOperationOptions

func (UpdateImpactedResourceOperationOptions) ToHeaders

func (UpdateImpactedResourceOperationOptions) ToOData

func (UpdateImpactedResourceOperationOptions) ToQuery

type UpdateImpactedResourceOperationResponse

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