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 ¶
- func PossibleValuesForAssignmentType() []string
- func PossibleValuesForMemberType() []string
- func PossibleValuesForPrincipalType() []string
- func PossibleValuesForStatus() []string
- func ValidateScopedRoleAssignmentScheduleID(input interface{}, key string) (warnings []string, errors []error)
- type AssignmentType
- type ExpandedProperties
- type ExpandedPropertiesPrincipal
- type ExpandedPropertiesRoleDefinition
- type ExpandedPropertiesScope
- type GetOperationResponse
- type ListForScopeCompleteResult
- type ListForScopeOperationOptions
- type ListForScopeOperationResponse
- type MemberType
- type PrincipalType
- type RoleAssignmentSchedule
- type RoleAssignmentScheduleOperationPredicate
- type RoleAssignmentScheduleProperties
- func (o *RoleAssignmentScheduleProperties) GetCreatedOnAsTime() (*time.Time, error)
- func (o *RoleAssignmentScheduleProperties) GetEndDateTimeAsTime() (*time.Time, error)
- func (o *RoleAssignmentScheduleProperties) GetStartDateTimeAsTime() (*time.Time, error)
- func (o *RoleAssignmentScheduleProperties) GetUpdatedOnAsTime() (*time.Time, error)
- func (o *RoleAssignmentScheduleProperties) SetCreatedOnAsTime(input time.Time)
- func (o *RoleAssignmentScheduleProperties) SetEndDateTimeAsTime(input time.Time)
- func (o *RoleAssignmentScheduleProperties) SetStartDateTimeAsTime(input time.Time)
- func (o *RoleAssignmentScheduleProperties) SetUpdatedOnAsTime(input time.Time)
- type RoleAssignmentSchedulesClient
- func (c RoleAssignmentSchedulesClient) Get(ctx context.Context, id ScopedRoleAssignmentScheduleId) (result GetOperationResponse, err error)
- func (c RoleAssignmentSchedulesClient) ListForScope(ctx context.Context, id commonids.ScopeId, ...) (result ListForScopeOperationResponse, err error)
- func (c RoleAssignmentSchedulesClient) ListForScopeComplete(ctx context.Context, id commonids.ScopeId, ...) (ListForScopeCompleteResult, error)
- func (c RoleAssignmentSchedulesClient) ListForScopeCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, ...) (result ListForScopeCompleteResult, err error)
- type ScopedRoleAssignmentScheduleId
- func NewScopedRoleAssignmentScheduleID(scope string, roleAssignmentScheduleName string) ScopedRoleAssignmentScheduleId
- func ParseScopedRoleAssignmentScheduleID(input string) (*ScopedRoleAssignmentScheduleId, error)
- func ParseScopedRoleAssignmentScheduleIDInsensitively(input string) (*ScopedRoleAssignmentScheduleId, error)
- type Status
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" )
func (*AssignmentType) UnmarshalJSON ¶ added in v0.20230516.1215417
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 ExpandedPropertiesScope ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *RoleAssignmentSchedule }
type ListForScopeCompleteResult ¶
type ListForScopeCompleteResult struct {
Items []RoleAssignmentSchedule
}
type ListForScopeOperationOptions ¶
type ListForScopeOperationOptions struct {
Filter *string
}
func DefaultListForScopeOperationOptions ¶
func DefaultListForScopeOperationOptions() ListForScopeOperationOptions
func (ListForScopeOperationOptions) ToHeaders ¶ added in v0.20230516.1215417
func (o ListForScopeOperationOptions) ToHeaders() *client.Headers
func (ListForScopeOperationOptions) ToOData ¶ added in v0.20230516.1215417
func (o ListForScopeOperationOptions) ToOData() *odata.Query
func (ListForScopeOperationOptions) ToQuery ¶ added in v0.20230516.1215417
func (o ListForScopeOperationOptions) ToQuery() *client.QueryParams
type ListForScopeOperationResponse ¶
type ListForScopeOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]RoleAssignmentSchedule }
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 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 ¶
func (RoleAssignmentScheduleOperationPredicate) Matches ¶
func (p RoleAssignmentScheduleOperationPredicate) Matches(input RoleAssignmentSchedule) bool
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 *resourcemanager.Client
}
func NewRoleAssignmentSchedulesClientWithBaseURI ¶
func NewRoleAssignmentSchedulesClientWithBaseURI(sdkApi sdkEnv.Api) (*RoleAssignmentSchedulesClient, error)
func (RoleAssignmentSchedulesClient) Get ¶
func (c RoleAssignmentSchedulesClient) Get(ctx context.Context, id ScopedRoleAssignmentScheduleId) (result GetOperationResponse, err error)
Get ...
func (RoleAssignmentSchedulesClient) ListForScope ¶
func (c RoleAssignmentSchedulesClient) ListForScope(ctx context.Context, id commonids.ScopeId, options ListForScopeOperationOptions) (result ListForScopeOperationResponse, err error)
ListForScope ...
func (RoleAssignmentSchedulesClient) ListForScopeComplete ¶
func (c RoleAssignmentSchedulesClient) ListForScopeComplete(ctx context.Context, id commonids.ScopeId, options ListForScopeOperationOptions) (ListForScopeCompleteResult, error)
ListForScopeComplete retrieves all the results into a single object
func (RoleAssignmentSchedulesClient) ListForScopeCompleteMatchingPredicate ¶
func (c RoleAssignmentSchedulesClient) ListForScopeCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options ListForScopeOperationOptions, predicate RoleAssignmentScheduleOperationPredicate) (result ListForScopeCompleteResult, err error)
ListForScopeCompleteMatchingPredicate retrieves all the results and then applies the predicate
type ScopedRoleAssignmentScheduleId ¶
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 ¶
func (id ScopedRoleAssignmentScheduleId) ID() string
ID returns the formatted Scoped Role Assignment Schedule ID
func (ScopedRoleAssignmentScheduleId) Segments ¶
func (id ScopedRoleAssignmentScheduleId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Scoped Role Assignment Schedule ID
func (ScopedRoleAssignmentScheduleId) String ¶
func (id ScopedRoleAssignmentScheduleId) String() 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" )
func (*Status) UnmarshalJSON ¶ added in v0.20230516.1215417
Source Files ¶
- client.go
- constants.go
- id_scopedroleassignmentschedule.go
- method_get.go
- method_listforscope.go
- model_expandedproperties.go
- model_expandedpropertiesprincipal.go
- model_expandedpropertiesroledefinition.go
- model_expandedpropertiesscope.go
- model_roleassignmentschedule.go
- model_roleassignmentscheduleproperties.go
- predicates.go
- version.go