roleassignmentscheduleinstances

package
v0.20241212.1154051 Latest Latest
Warning

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

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

README

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

The roleassignmentscheduleinstances SDK allows for interaction with Azure Resource Manager 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/authorization/2020-10-01/roleassignmentscheduleinstances"

Client Initialization

client := roleassignmentscheduleinstances.NewRoleAssignmentScheduleInstancesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RoleAssignmentScheduleInstancesClient.Get

ctx := context.TODO()
id := roleassignmentscheduleinstances.NewScopedRoleAssignmentScheduleInstanceID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleAssignmentScheduleInstanceName")

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: RoleAssignmentScheduleInstancesClient.ListForScope

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

// alternatively `client.ListForScope(ctx, id, roleassignmentscheduleinstances.DefaultListForScopeOperationOptions())` can be used to do batched pagination
items, err := client.ListForScopeComplete(ctx, id, roleassignmentscheduleinstances.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 PossibleValuesForAssignmentType

func PossibleValuesForAssignmentType() []string

func PossibleValuesForMemberType

func PossibleValuesForMemberType() []string

func PossibleValuesForPrincipalType

func PossibleValuesForPrincipalType() []string

func PossibleValuesForStatus

func PossibleValuesForStatus() []string

func ValidateScopedRoleAssignmentScheduleInstanceID

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

ValidateScopedRoleAssignmentScheduleInstanceID checks that 'input' can be parsed as a Scoped Role Assignment Schedule Instance ID

Types

type AssignmentType

type AssignmentType string
const (
	AssignmentTypeActivated AssignmentType = "Activated"
	AssignmentTypeAssigned  AssignmentType = "Assigned"
)

func (*AssignmentType) UnmarshalJSON

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

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        *RoleAssignmentScheduleInstance
}

type ListForScopeCompleteResult

type ListForScopeCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RoleAssignmentScheduleInstance
}

type ListForScopeCustomPager added in v0.20240628.1153531

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

type ListForScopeOperationOptions

type ListForScopeOperationOptions struct {
	Filter *string
}

func DefaultListForScopeOperationOptions

func DefaultListForScopeOperationOptions() ListForScopeOperationOptions

func (ListForScopeOperationOptions) ToHeaders

func (ListForScopeOperationOptions) ToOData

func (ListForScopeOperationOptions) ToQuery

type ListForScopeOperationResponse

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

type MemberType

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

func (*MemberType) UnmarshalJSON

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

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

type RoleAssignmentScheduleInstance

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

type RoleAssignmentScheduleInstanceOperationPredicate

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

func (RoleAssignmentScheduleInstanceOperationPredicate) Matches

type RoleAssignmentScheduleInstanceProperties

type RoleAssignmentScheduleInstanceProperties struct {
	AssignmentType                          *AssignmentType     `json:"assignmentType,omitempty"`
	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"`
	LinkedRoleEligibilityScheduleId         *string             `json:"linkedRoleEligibilityScheduleId,omitempty"`
	LinkedRoleEligibilityScheduleInstanceId *string             `json:"linkedRoleEligibilityScheduleInstanceId,omitempty"`
	MemberType                              *MemberType         `json:"memberType,omitempty"`
	OriginRoleAssignmentId                  *string             `json:"originRoleAssignmentId,omitempty"`
	PrincipalId                             *string             `json:"principalId,omitempty"`
	PrincipalType                           *PrincipalType      `json:"principalType,omitempty"`
	RoleAssignmentScheduleId                *string             `json:"roleAssignmentScheduleId,omitempty"`
	RoleDefinitionId                        *string             `json:"roleDefinitionId,omitempty"`
	Scope                                   *string             `json:"scope,omitempty"`
	StartDateTime                           *string             `json:"startDateTime,omitempty"`
	Status                                  *Status             `json:"status,omitempty"`
}

func (*RoleAssignmentScheduleInstanceProperties) GetCreatedOnAsTime

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

func (*RoleAssignmentScheduleInstanceProperties) GetEndDateTimeAsTime

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

func (*RoleAssignmentScheduleInstanceProperties) GetStartDateTimeAsTime

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

func (*RoleAssignmentScheduleInstanceProperties) SetCreatedOnAsTime

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

func (*RoleAssignmentScheduleInstanceProperties) SetEndDateTimeAsTime

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

func (*RoleAssignmentScheduleInstanceProperties) SetStartDateTimeAsTime

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

type RoleAssignmentScheduleInstancesClient

type RoleAssignmentScheduleInstancesClient struct {
	Client *resourcemanager.Client
}

func NewRoleAssignmentScheduleInstancesClientWithBaseURI

func NewRoleAssignmentScheduleInstancesClientWithBaseURI(sdkApi sdkEnv.Api) (*RoleAssignmentScheduleInstancesClient, error)

func (RoleAssignmentScheduleInstancesClient) Get

Get ...

func (RoleAssignmentScheduleInstancesClient) ListForScope

ListForScope ...

func (RoleAssignmentScheduleInstancesClient) ListForScopeComplete

ListForScopeComplete retrieves all the results into a single object

func (RoleAssignmentScheduleInstancesClient) ListForScopeCompleteMatchingPredicate

ListForScopeCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ScopedRoleAssignmentScheduleInstanceId

type ScopedRoleAssignmentScheduleInstanceId struct {
	Scope                              string
	RoleAssignmentScheduleInstanceName string
}

ScopedRoleAssignmentScheduleInstanceId is a struct representing the Resource ID for a Scoped Role Assignment Schedule Instance

func NewScopedRoleAssignmentScheduleInstanceID

func NewScopedRoleAssignmentScheduleInstanceID(scope string, roleAssignmentScheduleInstanceName string) ScopedRoleAssignmentScheduleInstanceId

NewScopedRoleAssignmentScheduleInstanceID returns a new ScopedRoleAssignmentScheduleInstanceId struct

func ParseScopedRoleAssignmentScheduleInstanceID

func ParseScopedRoleAssignmentScheduleInstanceID(input string) (*ScopedRoleAssignmentScheduleInstanceId, error)

ParseScopedRoleAssignmentScheduleInstanceID parses 'input' into a ScopedRoleAssignmentScheduleInstanceId

func ParseScopedRoleAssignmentScheduleInstanceIDInsensitively

func ParseScopedRoleAssignmentScheduleInstanceIDInsensitively(input string) (*ScopedRoleAssignmentScheduleInstanceId, error)

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

func (*ScopedRoleAssignmentScheduleInstanceId) FromParseResult

func (ScopedRoleAssignmentScheduleInstanceId) ID

ID returns the formatted Scoped Role Assignment Schedule Instance ID

func (ScopedRoleAssignmentScheduleInstanceId) Segments

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

func (ScopedRoleAssignmentScheduleInstanceId) String

String returns a human-readable description of this Scoped Role Assignment Schedule Instance 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

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