registrationassignments

package
v0.20240710.1075622 Latest Latest
Warning

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

Go to latest
Published: Jul 10, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/managedservices/2019-06-01/registrationassignments Documentation

The registrationassignments SDK allows for interaction with the Azure Resource Manager Service managedservices (API Version 2019-06-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/2019-06-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 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 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 ListCompleteResult

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

type ListCustomPager added in v0.20240628.1153531

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationOptions

type ListOperationOptions struct {
	ExpandRegistrationDefinition *bool
}

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

type ListOperationResponse

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

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"`
	Type       *string                           `json:"type,omitempty"`
}

type RegistrationAssignmentOperationPredicate

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

func (RegistrationAssignmentOperationPredicate) Matches

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"`
	Type       *string                                                           `json:"type,omitempty"`
}

type RegistrationAssignmentPropertiesRegistrationDefinitionProperties

type RegistrationAssignmentPropertiesRegistrationDefinitionProperties struct {
	Authorizations             *[]Authorization   `json:"authorizations,omitempty"`
	Description                *string            `json:"description,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

CreateOrUpdate ...

func (RegistrationAssignmentsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (RegistrationAssignmentsClient) Delete

Delete ...

func (RegistrationAssignmentsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (RegistrationAssignmentsClient) Get

Get ...

func (RegistrationAssignmentsClient) List

List ...

func (RegistrationAssignmentsClient) ListComplete

ListComplete retrieves all the results into a single object

func (RegistrationAssignmentsClient) ListCompleteMatchingPredicate

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

ID returns the formatted Scoped Registration Assignment ID

func (ScopedRegistrationAssignmentId) Segments

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

func (ScopedRegistrationAssignmentId) String

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

Jump to

Keyboard shortcuts

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