roleeligibilityschedulerequests

package
v0.20240319.1180522 Latest Latest
Warning

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

Go to latest
Published: Mar 19, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

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

The roleeligibilityschedulerequests 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/authorization/2020-10-01/roleeligibilityschedulerequests"

Client Initialization

client := roleeligibilityschedulerequests.NewRoleEligibilityScheduleRequestsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RoleEligibilityScheduleRequestsClient.Cancel

ctx := context.TODO()
id := roleeligibilityschedulerequests.NewScopedRoleEligibilityScheduleRequestID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleEligibilityScheduleRequestValue")

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

Example Usage: RoleEligibilityScheduleRequestsClient.Create

ctx := context.TODO()
id := roleeligibilityschedulerequests.NewScopedRoleEligibilityScheduleRequestID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleEligibilityScheduleRequestValue")

payload := roleeligibilityschedulerequests.RoleEligibilityScheduleRequest{
	// ...
}


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

Example Usage: RoleEligibilityScheduleRequestsClient.Get

ctx := context.TODO()
id := roleeligibilityschedulerequests.NewScopedRoleEligibilityScheduleRequestID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleEligibilityScheduleRequestValue")

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

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

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

Example Usage: RoleEligibilityScheduleRequestsClient.Validate

ctx := context.TODO()
id := roleeligibilityschedulerequests.NewScopedRoleEligibilityScheduleRequestID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleEligibilityScheduleRequestValue")

payload := roleeligibilityschedulerequests.RoleEligibilityScheduleRequest{
	// ...
}


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

func PossibleValuesForPrincipalType

func PossibleValuesForPrincipalType() []string

func PossibleValuesForRequestType

func PossibleValuesForRequestType() []string

func PossibleValuesForStatus

func PossibleValuesForStatus() []string

func PossibleValuesForType

func PossibleValuesForType() []string

func ValidateScopedRoleEligibilityScheduleRequestID

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

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

Types

type CancelOperationResponse

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

type CreateOperationResponse

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RoleEligibilityScheduleRequest
}

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

type ListForScopeCompleteResult

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

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        *[]RoleEligibilityScheduleRequest
}

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 RequestType

type RequestType string
const (
	RequestTypeAdminAssign    RequestType = "AdminAssign"
	RequestTypeAdminExtend    RequestType = "AdminExtend"
	RequestTypeAdminRemove    RequestType = "AdminRemove"
	RequestTypeAdminRenew     RequestType = "AdminRenew"
	RequestTypeAdminUpdate    RequestType = "AdminUpdate"
	RequestTypeSelfActivate   RequestType = "SelfActivate"
	RequestTypeSelfDeactivate RequestType = "SelfDeactivate"
	RequestTypeSelfExtend     RequestType = "SelfExtend"
	RequestTypeSelfRenew      RequestType = "SelfRenew"
)

func (*RequestType) UnmarshalJSON

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

type RoleEligibilityScheduleRequest

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

type RoleEligibilityScheduleRequestOperationPredicate

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

func (RoleEligibilityScheduleRequestOperationPredicate) Matches

type RoleEligibilityScheduleRequestProperties

type RoleEligibilityScheduleRequestProperties struct {
	ApprovalId                              *string                                               `json:"approvalId,omitempty"`
	Condition                               *string                                               `json:"condition,omitempty"`
	ConditionVersion                        *string                                               `json:"conditionVersion,omitempty"`
	CreatedOn                               *string                                               `json:"createdOn,omitempty"`
	ExpandedProperties                      *ExpandedProperties                                   `json:"expandedProperties,omitempty"`
	Justification                           *string                                               `json:"justification,omitempty"`
	PrincipalId                             string                                                `json:"principalId"`
	PrincipalType                           *PrincipalType                                        `json:"principalType,omitempty"`
	RequestType                             RequestType                                           `json:"requestType"`
	RequestorId                             *string                                               `json:"requestorId,omitempty"`
	RoleDefinitionId                        string                                                `json:"roleDefinitionId"`
	ScheduleInfo                            *RoleEligibilityScheduleRequestPropertiesScheduleInfo `json:"scheduleInfo,omitempty"`
	Scope                                   *string                                               `json:"scope,omitempty"`
	Status                                  *Status                                               `json:"status,omitempty"`
	TargetRoleEligibilityScheduleId         *string                                               `json:"targetRoleEligibilityScheduleId,omitempty"`
	TargetRoleEligibilityScheduleInstanceId *string                                               `json:"targetRoleEligibilityScheduleInstanceId,omitempty"`
	TicketInfo                              *RoleEligibilityScheduleRequestPropertiesTicketInfo   `json:"ticketInfo,omitempty"`
}

func (*RoleEligibilityScheduleRequestProperties) GetCreatedOnAsTime

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

func (*RoleEligibilityScheduleRequestProperties) SetCreatedOnAsTime

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

type RoleEligibilityScheduleRequestPropertiesScheduleInfo

type RoleEligibilityScheduleRequestPropertiesScheduleInfo struct {
	Expiration    *RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration `json:"expiration,omitempty"`
	StartDateTime *string                                                         `json:"startDateTime,omitempty"`
}

func (*RoleEligibilityScheduleRequestPropertiesScheduleInfo) GetStartDateTimeAsTime

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

func (*RoleEligibilityScheduleRequestPropertiesScheduleInfo) SetStartDateTimeAsTime

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

type RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration

type RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration struct {
	Duration    *string `json:"duration,omitempty"`
	EndDateTime *string `json:"endDateTime,omitempty"`
	Type        *Type   `json:"type,omitempty"`
}

func (*RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration) GetEndDateTimeAsTime

func (*RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration) SetEndDateTimeAsTime

type RoleEligibilityScheduleRequestPropertiesTicketInfo

type RoleEligibilityScheduleRequestPropertiesTicketInfo struct {
	TicketNumber *string `json:"ticketNumber,omitempty"`
	TicketSystem *string `json:"ticketSystem,omitempty"`
}

type RoleEligibilityScheduleRequestsClient

type RoleEligibilityScheduleRequestsClient struct {
	Client *resourcemanager.Client
}

func NewRoleEligibilityScheduleRequestsClientWithBaseURI

func NewRoleEligibilityScheduleRequestsClientWithBaseURI(sdkApi sdkEnv.Api) (*RoleEligibilityScheduleRequestsClient, error)

func (RoleEligibilityScheduleRequestsClient) Cancel

Cancel ...

func (RoleEligibilityScheduleRequestsClient) Create

Create ...

func (RoleEligibilityScheduleRequestsClient) Get

Get ...

func (RoleEligibilityScheduleRequestsClient) ListForScope

ListForScope ...

func (RoleEligibilityScheduleRequestsClient) ListForScopeComplete

ListForScopeComplete retrieves all the results into a single object

func (RoleEligibilityScheduleRequestsClient) ListForScopeCompleteMatchingPredicate

ListForScopeCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (RoleEligibilityScheduleRequestsClient) Validate

Validate ...

type ScopedRoleEligibilityScheduleRequestId

type ScopedRoleEligibilityScheduleRequestId struct {
	Scope                              string
	RoleEligibilityScheduleRequestName string
}

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

func NewScopedRoleEligibilityScheduleRequestID

func NewScopedRoleEligibilityScheduleRequestID(scope string, roleEligibilityScheduleRequestName string) ScopedRoleEligibilityScheduleRequestId

NewScopedRoleEligibilityScheduleRequestID returns a new ScopedRoleEligibilityScheduleRequestId struct

func ParseScopedRoleEligibilityScheduleRequestID

func ParseScopedRoleEligibilityScheduleRequestID(input string) (*ScopedRoleEligibilityScheduleRequestId, error)

ParseScopedRoleEligibilityScheduleRequestID parses 'input' into a ScopedRoleEligibilityScheduleRequestId

func ParseScopedRoleEligibilityScheduleRequestIDInsensitively

func ParseScopedRoleEligibilityScheduleRequestIDInsensitively(input string) (*ScopedRoleEligibilityScheduleRequestId, error)

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

func (*ScopedRoleEligibilityScheduleRequestId) FromParseResult

func (ScopedRoleEligibilityScheduleRequestId) ID

ID returns the formatted Scoped Role Eligibility Schedule Request ID

func (ScopedRoleEligibilityScheduleRequestId) Segments

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

func (ScopedRoleEligibilityScheduleRequestId) String

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

type Type

type Type string
const (
	TypeAfterDateTime Type = "AfterDateTime"
	TypeAfterDuration Type = "AfterDuration"
	TypeNoExpiration  Type = "NoExpiration"
)

func (*Type) UnmarshalJSON

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

type ValidateOperationResponse

type ValidateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RoleEligibilityScheduleRequest
}

Jump to

Keyboard shortcuts

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