roleeligibilityschedules

package
v0.20230525.1191903 Latest Latest
Warning

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

Go to latest
Published: May 25, 2023 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/authorization/2020-10-01/roleeligibilityschedules Documentation

The roleeligibilityschedules SDK allows for interaction with the Azure Resource Manager Service authorization (API Version 2020-10-01).

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/resource-manager/authorization/2020-10-01/roleeligibilityschedules"

Client Initialization

client := roleeligibilityschedules.NewRoleEligibilitySchedulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RoleEligibilitySchedulesClient.Get

ctx := context.TODO()
id := roleeligibilityschedules.NewScopedRoleEligibilityScheduleID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleEligibilityScheduleValue")

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

Example Usage: RoleEligibilitySchedulesClient.ListForScope

ctx := context.TODO()
id := roleeligibilityschedules.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForMemberType

func PossibleValuesForMemberType() []string

func PossibleValuesForPrincipalType

func PossibleValuesForPrincipalType() []string

func PossibleValuesForStatus

func PossibleValuesForStatus() []string

func ValidateScopedRoleEligibilityScheduleID

func ValidateScopedRoleEligibilityScheduleID(input interface{}, key string) (warnings []string, errors []error)

ValidateScopedRoleEligibilityScheduleID checks that 'input' can be parsed as a Scoped Role Eligibility Schedule ID

Types

type ExpandedProperties

type ExpandedProperties struct {
	Principal      *ExpandedPropertiesPrincipal      `json:"principal,omitempty"`
	RoleDefinition *ExpandedPropertiesRoleDefinition `json:"roleDefinition,omitempty"`
	Scope          *ExpandedPropertiesScope          `json:"scope,omitempty"`
}

type ExpandedPropertiesPrincipal

type ExpandedPropertiesPrincipal struct {
	DisplayName *string `json:"displayName,omitempty"`
	Email       *string `json:"email,omitempty"`
	Id          *string `json:"id,omitempty"`
	Type        *string `json:"type,omitempty"`
}

type ExpandedPropertiesRoleDefinition

type ExpandedPropertiesRoleDefinition struct {
	DisplayName *string `json:"displayName,omitempty"`
	Id          *string `json:"id,omitempty"`
	Type        *string `json:"type,omitempty"`
}

type ExpandedPropertiesScope

type ExpandedPropertiesScope struct {
	DisplayName *string `json:"displayName,omitempty"`
	Id          *string `json:"id,omitempty"`
	Type        *string `json:"type,omitempty"`
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RoleEligibilitySchedule
}

type ListForScopeCompleteResult

type ListForScopeCompleteResult struct {
	Items []RoleEligibilitySchedule
}

type ListForScopeOperationOptions

type ListForScopeOperationOptions struct {
	Filter *string
}

func DefaultListForScopeOperationOptions

func DefaultListForScopeOperationOptions() ListForScopeOperationOptions

func (ListForScopeOperationOptions) ToHeaders added in v0.20230516.1215417

func (ListForScopeOperationOptions) ToOData added in v0.20230516.1215417

func (ListForScopeOperationOptions) ToQuery added in v0.20230516.1215417

type ListForScopeOperationResponse

type ListForScopeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RoleEligibilitySchedule
}

type MemberType

type MemberType string
const (
	MemberTypeDirect    MemberType = "Direct"
	MemberTypeGroup     MemberType = "Group"
	MemberTypeInherited MemberType = "Inherited"
)

func (*MemberType) UnmarshalJSON added in v0.20230516.1215417

func (s *MemberType) UnmarshalJSON(bytes []byte) error

type PrincipalType

type PrincipalType string
const (
	PrincipalTypeDevice           PrincipalType = "Device"
	PrincipalTypeForeignGroup     PrincipalType = "ForeignGroup"
	PrincipalTypeGroup            PrincipalType = "Group"
	PrincipalTypeServicePrincipal PrincipalType = "ServicePrincipal"
	PrincipalTypeUser             PrincipalType = "User"
)

func (*PrincipalType) UnmarshalJSON added in v0.20230516.1215417

func (s *PrincipalType) UnmarshalJSON(bytes []byte) error

type RoleEligibilitySchedule

type RoleEligibilitySchedule struct {
	Id         *string                            `json:"id,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *RoleEligibilityScheduleProperties `json:"properties,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type RoleEligibilityScheduleOperationPredicate

type RoleEligibilityScheduleOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (RoleEligibilityScheduleOperationPredicate) Matches

type RoleEligibilityScheduleProperties

type RoleEligibilityScheduleProperties struct {
	Condition                        *string             `json:"condition,omitempty"`
	ConditionVersion                 *string             `json:"conditionVersion,omitempty"`
	CreatedOn                        *string             `json:"createdOn,omitempty"`
	EndDateTime                      *string             `json:"endDateTime,omitempty"`
	ExpandedProperties               *ExpandedProperties `json:"expandedProperties,omitempty"`
	MemberType                       *MemberType         `json:"memberType,omitempty"`
	PrincipalId                      *string             `json:"principalId,omitempty"`
	PrincipalType                    *PrincipalType      `json:"principalType,omitempty"`
	RoleDefinitionId                 *string             `json:"roleDefinitionId,omitempty"`
	RoleEligibilityScheduleRequestId *string             `json:"roleEligibilityScheduleRequestId,omitempty"`
	Scope                            *string             `json:"scope,omitempty"`
	StartDateTime                    *string             `json:"startDateTime,omitempty"`
	Status                           *Status             `json:"status,omitempty"`
	UpdatedOn                        *string             `json:"updatedOn,omitempty"`
}

func (*RoleEligibilityScheduleProperties) GetCreatedOnAsTime

func (o *RoleEligibilityScheduleProperties) GetCreatedOnAsTime() (*time.Time, error)

func (*RoleEligibilityScheduleProperties) GetEndDateTimeAsTime

func (o *RoleEligibilityScheduleProperties) GetEndDateTimeAsTime() (*time.Time, error)

func (*RoleEligibilityScheduleProperties) GetStartDateTimeAsTime

func (o *RoleEligibilityScheduleProperties) GetStartDateTimeAsTime() (*time.Time, error)

func (*RoleEligibilityScheduleProperties) GetUpdatedOnAsTime

func (o *RoleEligibilityScheduleProperties) GetUpdatedOnAsTime() (*time.Time, error)

func (*RoleEligibilityScheduleProperties) SetCreatedOnAsTime

func (o *RoleEligibilityScheduleProperties) SetCreatedOnAsTime(input time.Time)

func (*RoleEligibilityScheduleProperties) SetEndDateTimeAsTime

func (o *RoleEligibilityScheduleProperties) SetEndDateTimeAsTime(input time.Time)

func (*RoleEligibilityScheduleProperties) SetStartDateTimeAsTime

func (o *RoleEligibilityScheduleProperties) SetStartDateTimeAsTime(input time.Time)

func (*RoleEligibilityScheduleProperties) SetUpdatedOnAsTime

func (o *RoleEligibilityScheduleProperties) SetUpdatedOnAsTime(input time.Time)

type RoleEligibilitySchedulesClient

type RoleEligibilitySchedulesClient struct {
	Client *resourcemanager.Client
}

func NewRoleEligibilitySchedulesClientWithBaseURI

func NewRoleEligibilitySchedulesClientWithBaseURI(api environments.Api) (*RoleEligibilitySchedulesClient, error)

func (RoleEligibilitySchedulesClient) Get

Get ...

func (RoleEligibilitySchedulesClient) ListForScope

ListForScope ...

func (RoleEligibilitySchedulesClient) ListForScopeComplete

ListForScopeComplete retrieves all the results into a single object

func (RoleEligibilitySchedulesClient) ListForScopeCompleteMatchingPredicate

ListForScopeCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ScopedRoleEligibilityScheduleId

type ScopedRoleEligibilityScheduleId struct {
	Scope                       string
	RoleEligibilityScheduleName string
}

ScopedRoleEligibilityScheduleId is a struct representing the Resource ID for a Scoped Role Eligibility Schedule

func NewScopedRoleEligibilityScheduleID

func NewScopedRoleEligibilityScheduleID(scope string, roleEligibilityScheduleName string) ScopedRoleEligibilityScheduleId

NewScopedRoleEligibilityScheduleID returns a new ScopedRoleEligibilityScheduleId struct

func ParseScopedRoleEligibilityScheduleID

func ParseScopedRoleEligibilityScheduleID(input string) (*ScopedRoleEligibilityScheduleId, error)

ParseScopedRoleEligibilityScheduleID parses 'input' into a ScopedRoleEligibilityScheduleId

func ParseScopedRoleEligibilityScheduleIDInsensitively

func ParseScopedRoleEligibilityScheduleIDInsensitively(input string) (*ScopedRoleEligibilityScheduleId, error)

ParseScopedRoleEligibilityScheduleIDInsensitively parses 'input' case-insensitively into a ScopedRoleEligibilityScheduleId note: this method should only be used for API response data and not user input

func (ScopedRoleEligibilityScheduleId) ID

ID returns the formatted Scoped Role Eligibility Schedule ID

func (ScopedRoleEligibilityScheduleId) Segments

Segments returns a slice of Resource ID Segments which comprise this Scoped Role Eligibility Schedule ID

func (ScopedRoleEligibilityScheduleId) String

String returns a human-readable description of this Scoped Role Eligibility Schedule ID

type Status

type Status string
const (
	StatusAccepted                    Status = "Accepted"
	StatusAdminApproved               Status = "AdminApproved"
	StatusAdminDenied                 Status = "AdminDenied"
	StatusCanceled                    Status = "Canceled"
	StatusDenied                      Status = "Denied"
	StatusFailed                      Status = "Failed"
	StatusFailedAsResourceIsLocked    Status = "FailedAsResourceIsLocked"
	StatusGranted                     Status = "Granted"
	StatusInvalid                     Status = "Invalid"
	StatusPendingAdminDecision        Status = "PendingAdminDecision"
	StatusPendingApproval             Status = "PendingApproval"
	StatusPendingApprovalProvisioning Status = "PendingApprovalProvisioning"
	StatusPendingEvaluation           Status = "PendingEvaluation"
	StatusPendingExternalProvisioning Status = "PendingExternalProvisioning"
	StatusPendingProvisioning         Status = "PendingProvisioning"
	StatusPendingRevocation           Status = "PendingRevocation"
	StatusPendingScheduleCreation     Status = "PendingScheduleCreation"
	StatusProvisioned                 Status = "Provisioned"
	StatusProvisioningStarted         Status = "ProvisioningStarted"
	StatusRevoked                     Status = "Revoked"
	StatusScheduleCreated             Status = "ScheduleCreated"
	StatusTimedOut                    Status = "TimedOut"
)

func (*Status) UnmarshalJSON added in v0.20230516.1215417

func (s *Status) UnmarshalJSON(bytes []byte) error

Jump to

Keyboard shortcuts

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