roleassignmentschedules

package
v0.20230126.1083609 Latest Latest
Warning

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

Go to latest
Published: Jan 26, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

README

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

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

Client Initialization

client := roleassignmentschedules.NewRoleAssignmentSchedulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RoleAssignmentSchedulesClient.Get

ctx := context.TODO()
id := roleassignmentschedules.NewScopedRoleAssignmentScheduleID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleAssignmentScheduleValue")

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

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

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

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

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

Types

type AssignmentType

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

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
	Model        *RoleAssignmentSchedule
}

type ListForScopeCompleteResult

type ListForScopeCompleteResult struct {
	Items []RoleAssignmentSchedule
}

type ListForScopeOperationOptions

type ListForScopeOperationOptions struct {
	Filter *string
}

func DefaultListForScopeOperationOptions

func DefaultListForScopeOperationOptions() ListForScopeOperationOptions

type ListForScopeOperationResponse

type ListForScopeOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]RoleAssignmentSchedule
	// contains filtered or unexported fields
}

func (ListForScopeOperationResponse) HasMore

func (r ListForScopeOperationResponse) HasMore() bool

func (ListForScopeOperationResponse) LoadMore

type MemberType

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

type PrincipalType

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

type RoleAssignmentSchedule

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

type RoleAssignmentScheduleOperationPredicate

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

func (RoleAssignmentScheduleOperationPredicate) Matches

type RoleAssignmentScheduleProperties

type RoleAssignmentScheduleProperties 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"`
	MemberType                      *MemberType         `json:"memberType,omitempty"`
	PrincipalId                     *string             `json:"principalId,omitempty"`
	PrincipalType                   *PrincipalType      `json:"principalType,omitempty"`
	RoleAssignmentScheduleRequestId *string             `json:"roleAssignmentScheduleRequestId,omitempty"`
	RoleDefinitionId                *string             `json:"roleDefinitionId,omitempty"`
	Scope                           *string             `json:"scope,omitempty"`
	StartDateTime                   *string             `json:"startDateTime,omitempty"`
	Status                          *Status             `json:"status,omitempty"`
	UpdatedOn                       *string             `json:"updatedOn,omitempty"`
}

func (*RoleAssignmentScheduleProperties) GetCreatedOnAsTime

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

func (*RoleAssignmentScheduleProperties) GetEndDateTimeAsTime

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

func (*RoleAssignmentScheduleProperties) GetStartDateTimeAsTime

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

func (*RoleAssignmentScheduleProperties) GetUpdatedOnAsTime

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

func (*RoleAssignmentScheduleProperties) SetCreatedOnAsTime

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

func (*RoleAssignmentScheduleProperties) SetEndDateTimeAsTime

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

func (*RoleAssignmentScheduleProperties) SetStartDateTimeAsTime

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

func (*RoleAssignmentScheduleProperties) SetUpdatedOnAsTime

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

type RoleAssignmentSchedulesClient

type RoleAssignmentSchedulesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewRoleAssignmentSchedulesClientWithBaseURI

func NewRoleAssignmentSchedulesClientWithBaseURI(endpoint string) RoleAssignmentSchedulesClient

func (RoleAssignmentSchedulesClient) Get

Get ...

func (RoleAssignmentSchedulesClient) ListForScope

ListForScope ...

func (RoleAssignmentSchedulesClient) ListForScopeComplete

ListForScopeComplete retrieves all of the results into a single object

func (RoleAssignmentSchedulesClient) ListForScopeCompleteMatchingPredicate

ListForScopeCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type ScopedRoleAssignmentScheduleId

type ScopedRoleAssignmentScheduleId struct {
	Scope                      string
	RoleAssignmentScheduleName string
}

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

func NewScopedRoleAssignmentScheduleID

func NewScopedRoleAssignmentScheduleID(scope string, roleAssignmentScheduleName string) ScopedRoleAssignmentScheduleId

NewScopedRoleAssignmentScheduleID returns a new ScopedRoleAssignmentScheduleId struct

func ParseScopedRoleAssignmentScheduleID

func ParseScopedRoleAssignmentScheduleID(input string) (*ScopedRoleAssignmentScheduleId, error)

ParseScopedRoleAssignmentScheduleID parses 'input' into a ScopedRoleAssignmentScheduleId

func ParseScopedRoleAssignmentScheduleIDInsensitively

func ParseScopedRoleAssignmentScheduleIDInsensitively(input string) (*ScopedRoleAssignmentScheduleId, error)

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

func (ScopedRoleAssignmentScheduleId) ID

ID returns the formatted Scoped Role Assignment Schedule ID

func (ScopedRoleAssignmentScheduleId) Segments

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

func (ScopedRoleAssignmentScheduleId) String

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

Jump to

Keyboard shortcuts

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