registrationdefinitions

package
v0.20240923.1151247 Latest Latest
Warning

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

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

README

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

The registrationdefinitions SDK allows for interaction with Azure Resource Manager 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/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", "registrationDefinitionId")

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", "registrationDefinitionId")

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", "registrationDefinitionId")

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

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

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 ListOperationResponse

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

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

type RegistrationDefinitionOperationPredicate

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

func (RegistrationDefinitionOperationPredicate) Matches

type RegistrationDefinitionProperties

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

CreateOrUpdate ...

func (RegistrationDefinitionsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (RegistrationDefinitionsClient) Delete

Delete ...

func (RegistrationDefinitionsClient) Get

Get ...

func (RegistrationDefinitionsClient) List

List ...

func (RegistrationDefinitionsClient) ListComplete

ListComplete retrieves all the results into a single object

func (RegistrationDefinitionsClient) ListCompleteMatchingPredicate

func (c RegistrationDefinitionsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, 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

ID returns the formatted Scoped Registration Definition ID

func (ScopedRegistrationDefinitionId) Segments

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

func (ScopedRegistrationDefinitionId) String

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

Jump to

Keyboard shortcuts

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