registrationdefinitions

package
v0.20240731.1212841 Latest Latest
Warning

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

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

README

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

The registrationdefinitions 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/registrationdefinitions"

Client Initialization

client := registrationdefinitions.NewRegistrationDefinitionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RegistrationDefinitionsClient.CreateOrUpdate

ctx := context.TODO()
id := registrationdefinitions.NewScopedRegistrationDefinitionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "registrationDefinitionIdValue")

payload := registrationdefinitions.RegistrationDefinition{
	// ...
}


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

Example Usage: RegistrationDefinitionsClient.Delete

ctx := context.TODO()
id := registrationdefinitions.NewScopedRegistrationDefinitionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "registrationDefinitionIdValue")

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

Example Usage: RegistrationDefinitionsClient.Get

ctx := context.TODO()
id := registrationdefinitions.NewScopedRegistrationDefinitionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "registrationDefinitionIdValue")

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: RegistrationDefinitionsClient.List

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

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

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

ValidateScopedRegistrationDefinitionID checks that 'input' can be parsed as a Scoped Registration Definition 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        *RegistrationDefinition
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	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 GetOperationResponse 

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

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              []RegistrationDefinition
}

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

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 RegistrationDefinition 

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

type RegistrationDefinitionOperationPredicate 

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

func (RegistrationDefinitionOperationPredicate) Matches 

func (p RegistrationDefinitionOperationPredicate) Matches(input RegistrationDefinition) bool

type RegistrationDefinitionProperties 

type RegistrationDefinitionProperties struct {
	Authorizations             []Authorization          `json:"authorizations"`
	Description                *string                  `json:"description,omitempty"`
	EligibleAuthorizations     *[]EligibleAuthorization `json:"eligibleAuthorizations,omitempty"`
	ManagedByTenantId          string                   `json:"managedByTenantId"`
	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 RegistrationDefinitionsClient 

type RegistrationDefinitionsClient struct {
	Client *resourcemanager.Client
}

func NewRegistrationDefinitionsClientWithBaseURI 

func NewRegistrationDefinitionsClientWithBaseURI(sdkApi sdkEnv.Api) (*RegistrationDefinitionsClient, error)

func (RegistrationDefinitionsClient) CreateOrUpdate 

func (c RegistrationDefinitionsClient) CreateOrUpdate(ctx context.Context, id ScopedRegistrationDefinitionId, input RegistrationDefinition) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (RegistrationDefinitionsClient) CreateOrUpdateThenPoll 

func (c RegistrationDefinitionsClient) CreateOrUpdateThenPoll(ctx context.Context, id ScopedRegistrationDefinitionId, input RegistrationDefinition) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (RegistrationDefinitionsClient) Delete 

func (c RegistrationDefinitionsClient) Delete(ctx context.Context, id ScopedRegistrationDefinitionId) (result DeleteOperationResponse, err error)

Delete ...

func (RegistrationDefinitionsClient) Get 

func (c RegistrationDefinitionsClient) Get(ctx context.Context, id ScopedRegistrationDefinitionId) (result GetOperationResponse, err error)

Get ...

func (RegistrationDefinitionsClient) List 

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

List ...

func (RegistrationDefinitionsClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (RegistrationDefinitionsClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ScopedRegistrationDefinitionId 

type ScopedRegistrationDefinitionId struct {
	Scope                    string
	RegistrationDefinitionId string
}

ScopedRegistrationDefinitionId is a struct representing the Resource ID for a Scoped Registration Definition

func NewScopedRegistrationDefinitionID 

func NewScopedRegistrationDefinitionID(scope string, registrationDefinitionId string) ScopedRegistrationDefinitionId

NewScopedRegistrationDefinitionID returns a new ScopedRegistrationDefinitionId struct

func ParseScopedRegistrationDefinitionID 

func ParseScopedRegistrationDefinitionID(input string) (*ScopedRegistrationDefinitionId, error)

ParseScopedRegistrationDefinitionID parses 'input' into a ScopedRegistrationDefinitionId

func ParseScopedRegistrationDefinitionIDInsensitively 

func ParseScopedRegistrationDefinitionIDInsensitively(input string) (*ScopedRegistrationDefinitionId, error)

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

func (*ScopedRegistrationDefinitionId) FromParseResult 

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

func (ScopedRegistrationDefinitionId) ID 

func (id ScopedRegistrationDefinitionId) ID() string

ID returns the formatted Scoped Registration Definition ID

func (ScopedRegistrationDefinitionId) Segments 

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

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

func (ScopedRegistrationDefinitionId) String 

func (id ScopedRegistrationDefinitionId) String() string

String returns a human-readable description of this Scoped Registration Definition 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.