marketplaceregistrationdefinitions

package
v0.20240206.1080438 Latest Latest
Warning

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

Go to latest
Published: Feb 6, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

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

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

Client Initialization

client := marketplaceregistrationdefinitions.NewMarketplaceRegistrationDefinitionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MarketplaceRegistrationDefinitionsClient.Get

ctx := context.TODO()
id := marketplaceregistrationdefinitions.NewScopedMarketplaceRegistrationDefinitionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "marketplaceIdentifierValue")

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

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

// alternatively `client.List(ctx, id, marketplaceregistrationdefinitions.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, marketplaceregistrationdefinitions.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: MarketplaceRegistrationDefinitionsClient.WithoutScopeGet

ctx := context.TODO()
id := marketplaceregistrationdefinitions.NewMarketplaceRegistrationDefinitionID("marketplaceIdentifierValue")

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

Example Usage: MarketplaceRegistrationDefinitionsClient.WithoutScopeList

ctx := context.TODO()


// alternatively `client.WithoutScopeList(ctx, marketplaceregistrationdefinitions.DefaultWithoutScopeListOperationOptions())` can be used to do batched pagination
items, err := client.WithoutScopeListComplete(ctx, marketplaceregistrationdefinitions.DefaultWithoutScopeListOperationOptions())
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 ValidateMarketplaceRegistrationDefinitionID

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

ValidateMarketplaceRegistrationDefinitionID checks that 'input' can be parsed as a Marketplace Registration Definition ID

func ValidateScopedMarketplaceRegistrationDefinitionID

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

ValidateScopedMarketplaceRegistrationDefinitionID checks that 'input' can be parsed as a Scoped Marketplace 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 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        *MarketplaceRegistrationDefinition
}

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

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

type ListOperationResponse

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

type MarketplaceRegistrationDefinition

type MarketplaceRegistrationDefinition struct {
	Id         *string                                      `json:"id,omitempty"`
	Name       *string                                      `json:"name,omitempty"`
	Plan       *Plan                                        `json:"plan,omitempty"`
	Properties *MarketplaceRegistrationDefinitionProperties `json:"properties,omitempty"`
	Type       *string                                      `json:"type,omitempty"`
}

type MarketplaceRegistrationDefinitionId

type MarketplaceRegistrationDefinitionId struct {
	MarketplaceIdentifier string
}

MarketplaceRegistrationDefinitionId is a struct representing the Resource ID for a Marketplace Registration Definition

func NewMarketplaceRegistrationDefinitionID

func NewMarketplaceRegistrationDefinitionID(marketplaceIdentifier string) MarketplaceRegistrationDefinitionId

NewMarketplaceRegistrationDefinitionID returns a new MarketplaceRegistrationDefinitionId struct

func ParseMarketplaceRegistrationDefinitionID

func ParseMarketplaceRegistrationDefinitionID(input string) (*MarketplaceRegistrationDefinitionId, error)

ParseMarketplaceRegistrationDefinitionID parses 'input' into a MarketplaceRegistrationDefinitionId

func ParseMarketplaceRegistrationDefinitionIDInsensitively

func ParseMarketplaceRegistrationDefinitionIDInsensitively(input string) (*MarketplaceRegistrationDefinitionId, error)

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

func (*MarketplaceRegistrationDefinitionId) FromParseResult

func (MarketplaceRegistrationDefinitionId) ID

ID returns the formatted Marketplace Registration Definition ID

func (MarketplaceRegistrationDefinitionId) Segments

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

func (MarketplaceRegistrationDefinitionId) String

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

type MarketplaceRegistrationDefinitionOperationPredicate

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

func (MarketplaceRegistrationDefinitionOperationPredicate) Matches

type MarketplaceRegistrationDefinitionProperties

type MarketplaceRegistrationDefinitionProperties struct {
	Authorizations         []Authorization          `json:"authorizations"`
	EligibleAuthorizations *[]EligibleAuthorization `json:"eligibleAuthorizations,omitempty"`
	ManagedByTenantId      string                   `json:"managedByTenantId"`
	OfferDisplayName       *string                  `json:"offerDisplayName,omitempty"`
	PlanDisplayName        *string                  `json:"planDisplayName,omitempty"`
	PublisherDisplayName   *string                  `json:"publisherDisplayName,omitempty"`
}

type MarketplaceRegistrationDefinitionsClient

type MarketplaceRegistrationDefinitionsClient struct {
	Client *resourcemanager.Client
}

func NewMarketplaceRegistrationDefinitionsClientWithBaseURI

func NewMarketplaceRegistrationDefinitionsClientWithBaseURI(sdkApi sdkEnv.Api) (*MarketplaceRegistrationDefinitionsClient, error)

func (MarketplaceRegistrationDefinitionsClient) Get

Get ...

func (MarketplaceRegistrationDefinitionsClient) List

List ...

func (MarketplaceRegistrationDefinitionsClient) ListComplete

ListComplete retrieves all the results into a single object

func (MarketplaceRegistrationDefinitionsClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (MarketplaceRegistrationDefinitionsClient) WithoutScopeGet

WithoutScopeGet ...

func (MarketplaceRegistrationDefinitionsClient) WithoutScopeList

WithoutScopeList ...

func (MarketplaceRegistrationDefinitionsClient) WithoutScopeListComplete

WithoutScopeListComplete retrieves all the results into a single object

func (MarketplaceRegistrationDefinitionsClient) WithoutScopeListCompleteMatchingPredicate

WithoutScopeListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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 ScopedMarketplaceRegistrationDefinitionId

type ScopedMarketplaceRegistrationDefinitionId struct {
	Scope                 string
	MarketplaceIdentifier string
}

ScopedMarketplaceRegistrationDefinitionId is a struct representing the Resource ID for a Scoped Marketplace Registration Definition

func NewScopedMarketplaceRegistrationDefinitionID

func NewScopedMarketplaceRegistrationDefinitionID(scope string, marketplaceIdentifier string) ScopedMarketplaceRegistrationDefinitionId

NewScopedMarketplaceRegistrationDefinitionID returns a new ScopedMarketplaceRegistrationDefinitionId struct

func ParseScopedMarketplaceRegistrationDefinitionID

func ParseScopedMarketplaceRegistrationDefinitionID(input string) (*ScopedMarketplaceRegistrationDefinitionId, error)

ParseScopedMarketplaceRegistrationDefinitionID parses 'input' into a ScopedMarketplaceRegistrationDefinitionId

func ParseScopedMarketplaceRegistrationDefinitionIDInsensitively

func ParseScopedMarketplaceRegistrationDefinitionIDInsensitively(input string) (*ScopedMarketplaceRegistrationDefinitionId, error)

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

func (*ScopedMarketplaceRegistrationDefinitionId) FromParseResult

func (ScopedMarketplaceRegistrationDefinitionId) ID

ID returns the formatted Scoped Marketplace Registration Definition ID

func (ScopedMarketplaceRegistrationDefinitionId) Segments

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

func (ScopedMarketplaceRegistrationDefinitionId) String

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

type WithoutScopeGetOperationResponse

type WithoutScopeGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MarketplaceRegistrationDefinition
}

type WithoutScopeListCompleteResult

type WithoutScopeListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []MarketplaceRegistrationDefinition
}

type WithoutScopeListOperationOptions

type WithoutScopeListOperationOptions struct {
	Filter *string
}

func DefaultWithoutScopeListOperationOptions

func DefaultWithoutScopeListOperationOptions() WithoutScopeListOperationOptions

func (WithoutScopeListOperationOptions) ToHeaders

func (WithoutScopeListOperationOptions) ToOData

func (WithoutScopeListOperationOptions) ToQuery

type WithoutScopeListOperationResponse

type WithoutScopeListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]MarketplaceRegistrationDefinition
}

Jump to

Keyboard shortcuts

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