README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/authorization/2020-10-01/roleassignmentschedulerequests
Documentation
The roleassignmentschedulerequests
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/roleassignmentschedulerequests"
Client Initialization
client := roleassignmentschedulerequests.NewRoleAssignmentScheduleRequestsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: RoleAssignmentScheduleRequestsClient.Cancel
ctx := context.TODO()
id := roleassignmentschedulerequests.NewScopedRoleAssignmentScheduleRequestID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleAssignmentScheduleRequestValue")
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: RoleAssignmentScheduleRequestsClient.Create
ctx := context.TODO()
id := roleassignmentschedulerequests.NewScopedRoleAssignmentScheduleRequestID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleAssignmentScheduleRequestValue")
payload := roleassignmentschedulerequests.RoleAssignmentScheduleRequest{
// ...
}
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: RoleAssignmentScheduleRequestsClient.Get
ctx := context.TODO()
id := roleassignmentschedulerequests.NewScopedRoleAssignmentScheduleRequestID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleAssignmentScheduleRequestValue")
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: RoleAssignmentScheduleRequestsClient.ListForScope
ctx := context.TODO()
id := roleassignmentschedulerequests.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")
// alternatively `client.ListForScope(ctx, id, roleassignmentschedulerequests.DefaultListForScopeOperationOptions())` can be used to do batched pagination
items, err := client.ListForScopeComplete(ctx, id, roleassignmentschedulerequests.DefaultListForScopeOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: RoleAssignmentScheduleRequestsClient.Validate
ctx := context.TODO()
id := roleassignmentschedulerequests.NewScopedRoleAssignmentScheduleRequestID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "roleAssignmentScheduleRequestValue")
payload := roleassignmentschedulerequests.RoleAssignmentScheduleRequest{
// ...
}
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 ¶
- func PossibleValuesForPrincipalType() []string
- func PossibleValuesForRequestType() []string
- func PossibleValuesForStatus() []string
- func PossibleValuesForType() []string
- func ValidateScopedRoleAssignmentScheduleRequestID(input interface{}, key string) (warnings []string, errors []error)
- type CancelOperationResponse
- type CreateOperationResponse
- type ExpandedProperties
- type ExpandedPropertiesPrincipal
- type ExpandedPropertiesRoleDefinition
- type ExpandedPropertiesScope
- type GetOperationResponse
- type ListForScopeCompleteResult
- type ListForScopeOperationOptions
- type ListForScopeOperationResponse
- type PrincipalType
- type RequestType
- type RoleAssignmentScheduleRequest
- type RoleAssignmentScheduleRequestOperationPredicate
- type RoleAssignmentScheduleRequestProperties
- type RoleAssignmentScheduleRequestPropertiesScheduleInfo
- type RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration
- type RoleAssignmentScheduleRequestPropertiesTicketInfo
- type RoleAssignmentScheduleRequestsClient
- func (c RoleAssignmentScheduleRequestsClient) Cancel(ctx context.Context, id ScopedRoleAssignmentScheduleRequestId) (result CancelOperationResponse, err error)
- func (c RoleAssignmentScheduleRequestsClient) Create(ctx context.Context, id ScopedRoleAssignmentScheduleRequestId, ...) (result CreateOperationResponse, err error)
- func (c RoleAssignmentScheduleRequestsClient) Get(ctx context.Context, id ScopedRoleAssignmentScheduleRequestId) (result GetOperationResponse, err error)
- func (c RoleAssignmentScheduleRequestsClient) ListForScope(ctx context.Context, id commonids.ScopeId, ...) (result ListForScopeOperationResponse, err error)
- func (c RoleAssignmentScheduleRequestsClient) ListForScopeComplete(ctx context.Context, id commonids.ScopeId, ...) (ListForScopeCompleteResult, error)
- func (c RoleAssignmentScheduleRequestsClient) ListForScopeCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, ...) (result ListForScopeCompleteResult, err error)
- func (c RoleAssignmentScheduleRequestsClient) Validate(ctx context.Context, id ScopedRoleAssignmentScheduleRequestId, ...) (result ValidateOperationResponse, err error)
- type ScopedRoleAssignmentScheduleRequestId
- func NewScopedRoleAssignmentScheduleRequestID(scope string, roleAssignmentScheduleRequestName string) ScopedRoleAssignmentScheduleRequestId
- func ParseScopedRoleAssignmentScheduleRequestID(input string) (*ScopedRoleAssignmentScheduleRequestId, error)
- func ParseScopedRoleAssignmentScheduleRequestIDInsensitively(input string) (*ScopedRoleAssignmentScheduleRequestId, error)
- type Status
- type Type
- type ValidateOperationResponse
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 ValidateScopedRoleAssignmentScheduleRequestID ¶
func ValidateScopedRoleAssignmentScheduleRequestID(input interface{}, key string) (warnings []string, errors []error)
ValidateScopedRoleAssignmentScheduleRequestID checks that 'input' can be parsed as a Scoped Role Assignment Schedule Request ID
Types ¶
type CancelOperationResponse ¶
type CreateOperationResponse ¶
type CreateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *RoleAssignmentScheduleRequest }
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 *RoleAssignmentScheduleRequest }
type ListForScopeCompleteResult ¶
type ListForScopeCompleteResult struct {
Items []RoleAssignmentScheduleRequest
}
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 *[]RoleAssignmentScheduleRequest }
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 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 ¶ added in v0.20230516.1215417
func (s *RequestType) UnmarshalJSON(bytes []byte) error
type RoleAssignmentScheduleRequest ¶
type RoleAssignmentScheduleRequest struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *RoleAssignmentScheduleRequestProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type RoleAssignmentScheduleRequestOperationPredicate ¶
type RoleAssignmentScheduleRequestOperationPredicate struct { Id *string Name *string Type *string }
func (RoleAssignmentScheduleRequestOperationPredicate) Matches ¶
func (p RoleAssignmentScheduleRequestOperationPredicate) Matches(input RoleAssignmentScheduleRequest) bool
type RoleAssignmentScheduleRequestProperties ¶
type RoleAssignmentScheduleRequestProperties 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"` LinkedRoleEligibilityScheduleId *string `json:"linkedRoleEligibilityScheduleId,omitempty"` PrincipalId string `json:"principalId"` PrincipalType *PrincipalType `json:"principalType,omitempty"` RequestType RequestType `json:"requestType"` RequestorId *string `json:"requestorId,omitempty"` RoleDefinitionId string `json:"roleDefinitionId"` ScheduleInfo *RoleAssignmentScheduleRequestPropertiesScheduleInfo `json:"scheduleInfo,omitempty"` Scope *string `json:"scope,omitempty"` Status *Status `json:"status,omitempty"` TargetRoleAssignmentScheduleId *string `json:"targetRoleAssignmentScheduleId,omitempty"` TargetRoleAssignmentScheduleInstanceId *string `json:"targetRoleAssignmentScheduleInstanceId,omitempty"` TicketInfo *RoleAssignmentScheduleRequestPropertiesTicketInfo `json:"ticketInfo,omitempty"` }
func (*RoleAssignmentScheduleRequestProperties) GetCreatedOnAsTime ¶
func (o *RoleAssignmentScheduleRequestProperties) GetCreatedOnAsTime() (*time.Time, error)
func (*RoleAssignmentScheduleRequestProperties) SetCreatedOnAsTime ¶
func (o *RoleAssignmentScheduleRequestProperties) SetCreatedOnAsTime(input time.Time)
type RoleAssignmentScheduleRequestPropertiesScheduleInfo ¶
type RoleAssignmentScheduleRequestPropertiesScheduleInfo struct { Expiration *RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration `json:"expiration,omitempty"` StartDateTime *string `json:"startDateTime,omitempty"` }
func (*RoleAssignmentScheduleRequestPropertiesScheduleInfo) GetStartDateTimeAsTime ¶
func (o *RoleAssignmentScheduleRequestPropertiesScheduleInfo) GetStartDateTimeAsTime() (*time.Time, error)
func (*RoleAssignmentScheduleRequestPropertiesScheduleInfo) SetStartDateTimeAsTime ¶
func (o *RoleAssignmentScheduleRequestPropertiesScheduleInfo) SetStartDateTimeAsTime(input time.Time)
type RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration ¶
type RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration struct { Duration *string `json:"duration,omitempty"` EndDateTime *string `json:"endDateTime,omitempty"` Type *Type `json:"type,omitempty"` }
func (*RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration) GetEndDateTimeAsTime ¶
func (o *RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration) GetEndDateTimeAsTime() (*time.Time, error)
func (*RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration) SetEndDateTimeAsTime ¶
func (o *RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration) SetEndDateTimeAsTime(input time.Time)
type RoleAssignmentScheduleRequestsClient ¶
type RoleAssignmentScheduleRequestsClient struct {
Client *resourcemanager.Client
}
func NewRoleAssignmentScheduleRequestsClientWithBaseURI ¶
func NewRoleAssignmentScheduleRequestsClientWithBaseURI(sdkApi sdkEnv.Api) (*RoleAssignmentScheduleRequestsClient, error)
func (RoleAssignmentScheduleRequestsClient) Cancel ¶
func (c RoleAssignmentScheduleRequestsClient) Cancel(ctx context.Context, id ScopedRoleAssignmentScheduleRequestId) (result CancelOperationResponse, err error)
Cancel ...
func (RoleAssignmentScheduleRequestsClient) Create ¶
func (c RoleAssignmentScheduleRequestsClient) Create(ctx context.Context, id ScopedRoleAssignmentScheduleRequestId, input RoleAssignmentScheduleRequest) (result CreateOperationResponse, err error)
Create ...
func (RoleAssignmentScheduleRequestsClient) Get ¶
func (c RoleAssignmentScheduleRequestsClient) Get(ctx context.Context, id ScopedRoleAssignmentScheduleRequestId) (result GetOperationResponse, err error)
Get ...
func (RoleAssignmentScheduleRequestsClient) ListForScope ¶
func (c RoleAssignmentScheduleRequestsClient) ListForScope(ctx context.Context, id commonids.ScopeId, options ListForScopeOperationOptions) (result ListForScopeOperationResponse, err error)
ListForScope ...
func (RoleAssignmentScheduleRequestsClient) ListForScopeComplete ¶
func (c RoleAssignmentScheduleRequestsClient) ListForScopeComplete(ctx context.Context, id commonids.ScopeId, options ListForScopeOperationOptions) (ListForScopeCompleteResult, error)
ListForScopeComplete retrieves all the results into a single object
func (RoleAssignmentScheduleRequestsClient) ListForScopeCompleteMatchingPredicate ¶
func (c RoleAssignmentScheduleRequestsClient) ListForScopeCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options ListForScopeOperationOptions, predicate RoleAssignmentScheduleRequestOperationPredicate) (result ListForScopeCompleteResult, err error)
ListForScopeCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (RoleAssignmentScheduleRequestsClient) Validate ¶
func (c RoleAssignmentScheduleRequestsClient) Validate(ctx context.Context, id ScopedRoleAssignmentScheduleRequestId, input RoleAssignmentScheduleRequest) (result ValidateOperationResponse, err error)
Validate ...
type ScopedRoleAssignmentScheduleRequestId ¶
type ScopedRoleAssignmentScheduleRequestId struct { Scope string RoleAssignmentScheduleRequestName string }
ScopedRoleAssignmentScheduleRequestId is a struct representing the Resource ID for a Scoped Role Assignment Schedule Request
func NewScopedRoleAssignmentScheduleRequestID ¶
func NewScopedRoleAssignmentScheduleRequestID(scope string, roleAssignmentScheduleRequestName string) ScopedRoleAssignmentScheduleRequestId
NewScopedRoleAssignmentScheduleRequestID returns a new ScopedRoleAssignmentScheduleRequestId struct
func ParseScopedRoleAssignmentScheduleRequestID ¶
func ParseScopedRoleAssignmentScheduleRequestID(input string) (*ScopedRoleAssignmentScheduleRequestId, error)
ParseScopedRoleAssignmentScheduleRequestID parses 'input' into a ScopedRoleAssignmentScheduleRequestId
func ParseScopedRoleAssignmentScheduleRequestIDInsensitively ¶
func ParseScopedRoleAssignmentScheduleRequestIDInsensitively(input string) (*ScopedRoleAssignmentScheduleRequestId, error)
ParseScopedRoleAssignmentScheduleRequestIDInsensitively parses 'input' case-insensitively into a ScopedRoleAssignmentScheduleRequestId note: this method should only be used for API response data and not user input
func (ScopedRoleAssignmentScheduleRequestId) ID ¶
func (id ScopedRoleAssignmentScheduleRequestId) ID() string
ID returns the formatted Scoped Role Assignment Schedule Request ID
func (ScopedRoleAssignmentScheduleRequestId) Segments ¶
func (id ScopedRoleAssignmentScheduleRequestId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Scoped Role Assignment Schedule Request ID
func (ScopedRoleAssignmentScheduleRequestId) String ¶
func (id ScopedRoleAssignmentScheduleRequestId) String() string
String returns a human-readable description of this Scoped Role Assignment 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 ¶ added in v0.20230516.1215417
type ValidateOperationResponse ¶
type ValidateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *RoleAssignmentScheduleRequest }
Source Files ¶
- client.go
- constants.go
- id_scopedroleassignmentschedulerequest.go
- method_cancel.go
- method_create.go
- method_get.go
- method_listforscope.go
- method_validate.go
- model_expandedproperties.go
- model_expandedpropertiesprincipal.go
- model_expandedpropertiesroledefinition.go
- model_expandedpropertiesscope.go
- model_roleassignmentschedulerequest.go
- model_roleassignmentschedulerequestproperties.go
- model_roleassignmentschedulerequestpropertiesscheduleinfo.go
- model_roleassignmentschedulerequestpropertiesscheduleinfoexpiration.go
- model_roleassignmentschedulerequestpropertiesticketinfo.go
- predicates.go
- version.go