registrationassignments

package
v0.20240527.1094340 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/managedservices/2022-10-01/registrationassignments Documentation

The registrationassignments SDK allows for interaction with the Azure Resource Manager Service managedservices (API Version 2022-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/managedservices/2022-10-01/registrationassignments"

Client Initialization

client := registrationassignments.NewRegistrationAssignmentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RegistrationAssignmentsClient.CreateOrUpdate

ctx := context.TODO()
id := registrationassignments.NewScopedRegistrationAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "registrationAssignmentIdValue")

payload := registrationassignments.RegistrationAssignment{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: RegistrationAssignmentsClient.Delete

ctx := context.TODO()
id := registrationassignments.NewScopedRegistrationAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "registrationAssignmentIdValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: RegistrationAssignmentsClient.Get

ctx := context.TODO()
id := registrationassignments.NewScopedRegistrationAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "registrationAssignmentIdValue")

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

Example Usage: RegistrationAssignmentsClient.List

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

// alternatively `client.List(ctx, id, registrationassignments.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, registrationassignments.DefaultListOperationOptions())
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 PossibleValuesForMultiFactorAuthProvider 

func PossibleValuesForMultiFactorAuthProvider() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateScopedRegistrationAssignmentID 

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

ValidateScopedRegistrationAssignmentID checks that 'input' can be parsed as a Scoped Registration Assignment ID

Types

type Authorization 

type Authorization struct {
	DelegatedRoleDefinitionIds *[]string `json:"delegatedRoleDefinitionIds,omitempty"`
	PrincipalId                string    `json:"principalId"`
	PrincipalIdDisplayName     *string   `json:"principalIdDisplayName,omitempty"`
	RoleDefinitionId           string    `json:"roleDefinitionId"`
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RegistrationAssignment
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type EligibleApprover 

type EligibleApprover struct {
	PrincipalId            string  `json:"principalId"`
	PrincipalIdDisplayName *string `json:"principalIdDisplayName,omitempty"`
}

type EligibleAuthorization 

type EligibleAuthorization struct {
	JustInTimeAccessPolicy *JustInTimeAccessPolicy `json:"justInTimeAccessPolicy,omitempty"`
	PrincipalId            string                  `json:"principalId"`
	PrincipalIdDisplayName *string                 `json:"principalIdDisplayName,omitempty"`
	RoleDefinitionId       string                  `json:"roleDefinitionId"`
}

type GetOperationOptions 

type GetOperationOptions struct {
	ExpandRegistrationDefinition *bool
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders 

func (o GetOperationOptions) ToHeaders() *client.Headers

func (GetOperationOptions) ToOData 

func (o GetOperationOptions) ToOData() *odata.Query

func (GetOperationOptions) ToQuery 

func (o GetOperationOptions) ToQuery() *client.QueryParams

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RegistrationAssignment
}

type JustInTimeAccessPolicy 

type JustInTimeAccessPolicy struct {
	ManagedByTenantApprovers  *[]EligibleApprover     `json:"managedByTenantApprovers,omitempty"`
	MaximumActivationDuration *string                 `json:"maximumActivationDuration,omitempty"`
	MultiFactorAuthProvider   MultiFactorAuthProvider `json:"multiFactorAuthProvider"`
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RegistrationAssignment
}

type ListOperationOptions 

type ListOperationOptions struct {
	ExpandRegistrationDefinition *bool
	Filter                       *string
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData 

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery 

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RegistrationAssignment
}

type MultiFactorAuthProvider 

type MultiFactorAuthProvider string
const (
	MultiFactorAuthProviderAzure MultiFactorAuthProvider = "Azure"
	MultiFactorAuthProviderNone  MultiFactorAuthProvider = "None"
)

func (*MultiFactorAuthProvider) UnmarshalJSON 

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

type Plan 

type Plan struct {
	Name      string `json:"name"`
	Product   string `json:"product"`
	Publisher string `json:"publisher"`
	Version   string `json:"version"`
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateCreated      ProvisioningState = "Created"
	ProvisioningStateCreating     ProvisioningState = "Creating"
	ProvisioningStateDeleted      ProvisioningState = "Deleted"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateNotSpecified ProvisioningState = "NotSpecified"
	ProvisioningStateReady        ProvisioningState = "Ready"
	ProvisioningStateRunning      ProvisioningState = "Running"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type RegistrationAssignment 

type RegistrationAssignment struct {
	Id         *string                           `json:"id,omitempty"`
	Name       *string                           `json:"name,omitempty"`
	Properties *RegistrationAssignmentProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData            `json:"systemData,omitempty"`
	Type       *string                           `json:"type,omitempty"`
}

type RegistrationAssignmentOperationPredicate 

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

func (RegistrationAssignmentOperationPredicate) Matches 

func (p RegistrationAssignmentOperationPredicate) Matches(input RegistrationAssignment) bool

type RegistrationAssignmentProperties 

type RegistrationAssignmentProperties struct {
	ProvisioningState        *ProvisioningState                                      `json:"provisioningState,omitempty"`
	RegistrationDefinition   *RegistrationAssignmentPropertiesRegistrationDefinition `json:"registrationDefinition,omitempty"`
	RegistrationDefinitionId string                                                  `json:"registrationDefinitionId"`
}

type RegistrationAssignmentPropertiesRegistrationDefinition 

type RegistrationAssignmentPropertiesRegistrationDefinition struct {
	Id         *string                                                           `json:"id,omitempty"`
	Name       *string                                                           `json:"name,omitempty"`
	Plan       *Plan                                                             `json:"plan,omitempty"`
	Properties *RegistrationAssignmentPropertiesRegistrationDefinitionProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData                                            `json:"systemData,omitempty"`
	Type       *string                                                           `json:"type,omitempty"`
}

type RegistrationAssignmentPropertiesRegistrationDefinitionProperties 

type RegistrationAssignmentPropertiesRegistrationDefinitionProperties struct {
	Authorizations             *[]Authorization         `json:"authorizations,omitempty"`
	Description                *string                  `json:"description,omitempty"`
	EligibleAuthorizations     *[]EligibleAuthorization `json:"eligibleAuthorizations,omitempty"`
	ManagedByTenantId          *string                  `json:"managedByTenantId,omitempty"`
	ManagedByTenantName        *string                  `json:"managedByTenantName,omitempty"`
	ManageeTenantId            *string                  `json:"manageeTenantId,omitempty"`
	ManageeTenantName          *string                  `json:"manageeTenantName,omitempty"`
	ProvisioningState          *ProvisioningState       `json:"provisioningState,omitempty"`
	RegistrationDefinitionName *string                  `json:"registrationDefinitionName,omitempty"`
}

type RegistrationAssignmentsClient 

type RegistrationAssignmentsClient struct {
	Client *resourcemanager.Client
}

func NewRegistrationAssignmentsClientWithBaseURI 

func NewRegistrationAssignmentsClientWithBaseURI(sdkApi sdkEnv.Api) (*RegistrationAssignmentsClient, error)

func (RegistrationAssignmentsClient) CreateOrUpdate 

func (c RegistrationAssignmentsClient) CreateOrUpdate(ctx context.Context, id ScopedRegistrationAssignmentId, input RegistrationAssignment) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (RegistrationAssignmentsClient) CreateOrUpdateThenPoll 

func (c RegistrationAssignmentsClient) CreateOrUpdateThenPoll(ctx context.Context, id ScopedRegistrationAssignmentId, input RegistrationAssignment) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (RegistrationAssignmentsClient) Delete 

func (c RegistrationAssignmentsClient) Delete(ctx context.Context, id ScopedRegistrationAssignmentId) (result DeleteOperationResponse, err error)

Delete ...

func (RegistrationAssignmentsClient) DeleteThenPoll 

func (c RegistrationAssignmentsClient) DeleteThenPoll(ctx context.Context, id ScopedRegistrationAssignmentId) error

DeleteThenPoll performs Delete then polls until it's completed

func (RegistrationAssignmentsClient) Get 

func (c RegistrationAssignmentsClient) Get(ctx context.Context, id ScopedRegistrationAssignmentId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (RegistrationAssignmentsClient) List 

func (c RegistrationAssignmentsClient) List(ctx context.Context, id commonids.ScopeId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (RegistrationAssignmentsClient) ListComplete 

func (c RegistrationAssignmentsClient) ListComplete(ctx context.Context, id commonids.ScopeId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (RegistrationAssignmentsClient) ListCompleteMatchingPredicate 

func (c RegistrationAssignmentsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options ListOperationOptions, predicate RegistrationAssignmentOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ScopedRegistrationAssignmentId 

type ScopedRegistrationAssignmentId struct {
	Scope                    string
	RegistrationAssignmentId string
}

ScopedRegistrationAssignmentId is a struct representing the Resource ID for a Scoped Registration Assignment

func NewScopedRegistrationAssignmentID 

func NewScopedRegistrationAssignmentID(scope string, registrationAssignmentId string) ScopedRegistrationAssignmentId

NewScopedRegistrationAssignmentID returns a new ScopedRegistrationAssignmentId struct

func ParseScopedRegistrationAssignmentID 

func ParseScopedRegistrationAssignmentID(input string) (*ScopedRegistrationAssignmentId, error)

ParseScopedRegistrationAssignmentID parses 'input' into a ScopedRegistrationAssignmentId

func ParseScopedRegistrationAssignmentIDInsensitively 

func ParseScopedRegistrationAssignmentIDInsensitively(input string) (*ScopedRegistrationAssignmentId, error)

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

func (*ScopedRegistrationAssignmentId) FromParseResult 

func (id *ScopedRegistrationAssignmentId) FromParseResult(input resourceids.ParseResult) error

func (ScopedRegistrationAssignmentId) ID 

func (id ScopedRegistrationAssignmentId) ID() string

ID returns the formatted Scoped Registration Assignment ID

func (ScopedRegistrationAssignmentId) Segments 

func (id ScopedRegistrationAssignmentId) Segments() []resourceids.Segment

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

func (ScopedRegistrationAssignmentId) String 

func (id ScopedRegistrationAssignmentId) String() string

String returns a human-readable description of this Scoped Registration Assignment ID

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.