entitlementmanagementaccesspackage

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

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/identitygovernance/beta/entitlementmanagementaccesspackage Documentation

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

Client Initialization

client := entitlementmanagementaccesspackage.NewEntitlementManagementAccessPackageClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: EntitlementManagementAccessPackageClient.CreateEntitlementManagementAccessPackage

ctx := context.TODO()

payload := entitlementmanagementaccesspackage.AccessPackage{
	// ...
}


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

Example Usage: EntitlementManagementAccessPackageClient.DeleteEntitlementManagementAccessPackage

ctx := context.TODO()
id := entitlementmanagementaccesspackage.NewIdentityGovernanceEntitlementManagementAccessPackageID("accessPackageId")

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

Example Usage: EntitlementManagementAccessPackageClient.GetEntitlementManagementAccessPackage

ctx := context.TODO()
id := entitlementmanagementaccesspackage.NewIdentityGovernanceEntitlementManagementAccessPackageID("accessPackageId")

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

Example Usage: EntitlementManagementAccessPackageClient.GetEntitlementManagementAccessPackageApplicablePolicyRequirements

ctx := context.TODO()
id := entitlementmanagementaccesspackage.NewIdentityGovernanceEntitlementManagementAccessPackageID("accessPackageId")

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

Example Usage: EntitlementManagementAccessPackageClient.GetEntitlementManagementAccessPackagesCount

ctx := context.TODO()


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

Example Usage: EntitlementManagementAccessPackageClient.ListEntitlementManagementAccessPackages

ctx := context.TODO()


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

Example Usage: EntitlementManagementAccessPackageClient.MoveEntitlementManagementAccessPackageToCatalog

ctx := context.TODO()
id := entitlementmanagementaccesspackage.NewIdentityGovernanceEntitlementManagementAccessPackageID("accessPackageId")

payload := entitlementmanagementaccesspackage.MoveEntitlementManagementAccessPackageToCatalogRequest{
	// ...
}


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

Example Usage: EntitlementManagementAccessPackageClient.UpdateEntitlementManagementAccessPackage

ctx := context.TODO()
id := entitlementmanagementaccesspackage.NewIdentityGovernanceEntitlementManagementAccessPackageID("accessPackageId")

payload := entitlementmanagementaccesspackage.AccessPackage{
	// ...
}


read, err := client.UpdateEntitlementManagementAccessPackage(ctx, id, payload, entitlementmanagementaccesspackage.DefaultUpdateEntitlementManagementAccessPackageOperationOptions())
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 AccessPackageAssignmentRequestRequirementsOperationPredicate

type AccessPackageAssignmentRequestRequirementsOperationPredicate struct {
}

func (AccessPackageAssignmentRequestRequirementsOperationPredicate) Matches

type AccessPackageOperationPredicate

type AccessPackageOperationPredicate struct {
}

func (AccessPackageOperationPredicate) Matches

type CreateEntitlementManagementAccessPackageOperationOptions

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

func (CreateEntitlementManagementAccessPackageOperationOptions) ToHeaders

func (CreateEntitlementManagementAccessPackageOperationOptions) ToOData

func (CreateEntitlementManagementAccessPackageOperationOptions) ToQuery

type CreateEntitlementManagementAccessPackageOperationResponse

type CreateEntitlementManagementAccessPackageOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.AccessPackage
}

type DeleteEntitlementManagementAccessPackageOperationOptions

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

func (DeleteEntitlementManagementAccessPackageOperationOptions) ToHeaders

func (DeleteEntitlementManagementAccessPackageOperationOptions) ToOData

func (DeleteEntitlementManagementAccessPackageOperationOptions) ToQuery

type DeleteEntitlementManagementAccessPackageOperationResponse

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

type EntitlementManagementAccessPackageClient

type EntitlementManagementAccessPackageClient struct {
	Client *msgraph.Client
}

func NewEntitlementManagementAccessPackageClientWithBaseURI

func NewEntitlementManagementAccessPackageClientWithBaseURI(sdkApi sdkEnv.Api) (*EntitlementManagementAccessPackageClient, error)

func (EntitlementManagementAccessPackageClient) CreateEntitlementManagementAccessPackage

CreateEntitlementManagementAccessPackage - Create accessPackage. Create a new accessPackage object. The access package will be added to an existing accessPackageCatalog. After the access package is created, you can then create accessPackageAssignmentPolicies which specify how users are assigned to the access package.

func (EntitlementManagementAccessPackageClient) DeleteEntitlementManagementAccessPackage

DeleteEntitlementManagementAccessPackage - Delete accessPackage. Delete an accessPackage object. You can't delete an access package if it has any accessPackageAssignment. To delete the access package, first query if there are any assignments with a filter to indicate the specific access package, such as: $filter=accessPackage/id eq 'a914b616-e04e-476b-aa37-91038f0b165b'. For more information on how to remove assignments that are still in the delivered state, see Remove an assignment.

func (EntitlementManagementAccessPackageClient) GetEntitlementManagementAccessPackage

GetEntitlementManagementAccessPackage - Get accessPackage. Retrieve the properties and relationships of an accessPackage object.

func (EntitlementManagementAccessPackageClient) GetEntitlementManagementAccessPackageApplicablePolicyRequirements

GetEntitlementManagementAccessPackageApplicablePolicyRequirements - Invoke action getApplicablePolicyRequirements. In Microsoft Entra entitlement management, this action retrieves a list of accessPackageAssignmentRequestRequirements objects that the currently signed-in user can use to create an accessPackageAssignmentRequest. Each requirement object corresponds to an access package assignment policy that the currently signed-in user is allowed to request an assignment for.

func (EntitlementManagementAccessPackageClient) GetEntitlementManagementAccessPackageApplicablePolicyRequirementsComplete

GetEntitlementManagementAccessPackageApplicablePolicyRequirementsComplete retrieves all the results into a single object

func (EntitlementManagementAccessPackageClient) GetEntitlementManagementAccessPackageApplicablePolicyRequirementsCompleteMatchingPredicate

GetEntitlementManagementAccessPackageApplicablePolicyRequirementsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EntitlementManagementAccessPackageClient) GetEntitlementManagementAccessPackagesCount

GetEntitlementManagementAccessPackagesCount - Get the number of the resource

func (EntitlementManagementAccessPackageClient) ListEntitlementManagementAccessPackages

ListEntitlementManagementAccessPackages - List accessPackages. Retrieve a list of accessPackage objects. The resulting list includes all the access packages that the caller has access to read, across all catalogs.

func (EntitlementManagementAccessPackageClient) ListEntitlementManagementAccessPackagesComplete

ListEntitlementManagementAccessPackagesComplete retrieves all the results into a single object

func (EntitlementManagementAccessPackageClient) ListEntitlementManagementAccessPackagesCompleteMatchingPredicate

ListEntitlementManagementAccessPackagesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EntitlementManagementAccessPackageClient) MoveEntitlementManagementAccessPackageToCatalog

MoveEntitlementManagementAccessPackageToCatalog - Invoke action moveToCatalog. In Microsoft Entra entitlement management, this action moves the accessPackage to a specified target accessPackageCatalog. The resources in the access package must be present in the target catalog.

func (EntitlementManagementAccessPackageClient) UpdateEntitlementManagementAccessPackage

UpdateEntitlementManagementAccessPackage - Update accessPackage. Update an existing accessPackage object to change one or more of its properties, such as the display name or description.

type GetEntitlementManagementAccessPackageApplicablePolicyRequirementsCompleteResult

type GetEntitlementManagementAccessPackageApplicablePolicyRequirementsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.AccessPackageAssignmentRequestRequirements
}

type GetEntitlementManagementAccessPackageApplicablePolicyRequirementsCustomPager

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

type GetEntitlementManagementAccessPackageApplicablePolicyRequirementsOperationOptions

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

func (GetEntitlementManagementAccessPackageApplicablePolicyRequirementsOperationOptions) ToHeaders

func (GetEntitlementManagementAccessPackageApplicablePolicyRequirementsOperationOptions) ToOData

func (GetEntitlementManagementAccessPackageApplicablePolicyRequirementsOperationOptions) ToQuery

type GetEntitlementManagementAccessPackageApplicablePolicyRequirementsOperationResponse

type GetEntitlementManagementAccessPackageApplicablePolicyRequirementsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.AccessPackageAssignmentRequestRequirements
}

type GetEntitlementManagementAccessPackageOperationOptions

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

func DefaultGetEntitlementManagementAccessPackageOperationOptions

func DefaultGetEntitlementManagementAccessPackageOperationOptions() GetEntitlementManagementAccessPackageOperationOptions

func (GetEntitlementManagementAccessPackageOperationOptions) ToHeaders

func (GetEntitlementManagementAccessPackageOperationOptions) ToOData

func (GetEntitlementManagementAccessPackageOperationOptions) ToQuery

type GetEntitlementManagementAccessPackageOperationResponse

type GetEntitlementManagementAccessPackageOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.AccessPackage
}

type GetEntitlementManagementAccessPackagesCountOperationOptions

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

func (GetEntitlementManagementAccessPackagesCountOperationOptions) ToHeaders

func (GetEntitlementManagementAccessPackagesCountOperationOptions) ToOData

func (GetEntitlementManagementAccessPackagesCountOperationOptions) ToQuery

type GetEntitlementManagementAccessPackagesCountOperationResponse

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

type ListEntitlementManagementAccessPackagesCompleteResult

type ListEntitlementManagementAccessPackagesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.AccessPackage
}

type ListEntitlementManagementAccessPackagesCustomPager

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

type ListEntitlementManagementAccessPackagesOperationOptions

type ListEntitlementManagementAccessPackagesOperationOptions 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 (ListEntitlementManagementAccessPackagesOperationOptions) ToHeaders

func (ListEntitlementManagementAccessPackagesOperationOptions) ToOData

func (ListEntitlementManagementAccessPackagesOperationOptions) ToQuery

type ListEntitlementManagementAccessPackagesOperationResponse

type ListEntitlementManagementAccessPackagesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.AccessPackage
}

type MoveEntitlementManagementAccessPackageToCatalogOperationOptions

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

func (MoveEntitlementManagementAccessPackageToCatalogOperationOptions) ToHeaders

func (MoveEntitlementManagementAccessPackageToCatalogOperationOptions) ToOData

func (MoveEntitlementManagementAccessPackageToCatalogOperationOptions) ToQuery

type MoveEntitlementManagementAccessPackageToCatalogOperationResponse

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

type MoveEntitlementManagementAccessPackageToCatalogRequest

type MoveEntitlementManagementAccessPackageToCatalogRequest struct {
	CatalogId *string `json:"catalogId,omitempty"`
}

type UpdateEntitlementManagementAccessPackageOperationOptions

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

func (UpdateEntitlementManagementAccessPackageOperationOptions) ToHeaders

func (UpdateEntitlementManagementAccessPackageOperationOptions) ToOData

func (UpdateEntitlementManagementAccessPackageOperationOptions) ToQuery

type UpdateEntitlementManagementAccessPackageOperationResponse

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