registrationdefinitions

README

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

The registrationdefinitions 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-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", "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 := registrationdefinitions.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

• func PossibleValuesForProvisioningState() []string
• func ValidateScopedRegistrationDefinitionID(input interface{}, key string) (warnings []string, errors []error)
• type Authorization
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse
  • func (r ListOperationResponse) HasMore() bool
  • func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)
• type Plan
• type ProvisioningState
• type RegistrationDefinition
• type RegistrationDefinitionOperationPredicate
  • func (p RegistrationDefinitionOperationPredicate) Matches(input RegistrationDefinition) bool
• type RegistrationDefinitionProperties
• type RegistrationDefinitionsClient
  • func NewRegistrationDefinitionsClientWithBaseURI(endpoint string) RegistrationDefinitionsClient
  • func (c RegistrationDefinitionsClient) CreateOrUpdate(ctx context.Context, id ScopedRegistrationDefinitionId, ...) (result CreateOrUpdateOperationResponse, err error)
  • func (c RegistrationDefinitionsClient) CreateOrUpdateThenPoll(ctx context.Context, id ScopedRegistrationDefinitionId, ...) error
  • func (c RegistrationDefinitionsClient) Delete(ctx context.Context, id ScopedRegistrationDefinitionId) (result DeleteOperationResponse, err error)
  • func (c RegistrationDefinitionsClient) Get(ctx context.Context, id ScopedRegistrationDefinitionId) (result GetOperationResponse, err error)
  • func (c RegistrationDefinitionsClient) List(ctx context.Context, id commonids.ScopeId) (resp ListOperationResponse, err error)
  • func (c RegistrationDefinitionsClient) ListComplete(ctx context.Context, id commonids.ScopeId) (ListCompleteResult, error)
  • func (c RegistrationDefinitionsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, ...) (resp ListCompleteResult, err error)
• type ScopedRegistrationDefinitionId
  • func NewScopedRegistrationDefinitionID(scope string, registrationDefinitionId string) ScopedRegistrationDefinitionId
  • func ParseScopedRegistrationDefinitionID(input string) (*ScopedRegistrationDefinitionId, error)
  • func ParseScopedRegistrationDefinitionIDInsensitively(input string) (*ScopedRegistrationDefinitionId, error)
  • func (id ScopedRegistrationDefinitionId) ID() string
  • func (id ScopedRegistrationDefinitionId) Segments() []resourceids.Segment
  • func (id ScopedRegistrationDefinitionId) String() string

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       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []RegistrationDefinition
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]RegistrationDefinition
	// contains filtered or unexported fields
}

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err 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"
)

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

func (p RegistrationDefinitionOperationPredicate) Matches(input RegistrationDefinition) bool

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 autorest.Client
	// contains filtered or unexported fields
}

func NewRegistrationDefinitionsClientWithBaseURI

func NewRegistrationDefinitionsClientWithBaseURI(endpoint string) RegistrationDefinitionsClient

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) (resp ListOperationResponse, err error)

List ...

func (RegistrationDefinitionsClient) ListComplete

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

ListComplete retrieves all of the results into a single object

func (RegistrationDefinitionsClient) ListCompleteMatchingPredicate

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

ListCompleteMatchingPredicate retrieves all of the results and then applied 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) 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