providers

package
v0.20240228.1142829 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/resources/2020-10-01/providers Documentation

The providers SDK allows for interaction with the Azure Resource Manager Service resources (API Version 2020-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/resources/2020-10-01/providers"

Client Initialization

client := providers.NewProvidersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ProvidersClient.Get

ctx := context.TODO()
id := providers.NewSubscriptionProviderID("12345678-1234-9876-4563-123456789012", "providerValue")

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

Example Usage: ProvidersClient.GetAtTenantScope

ctx := context.TODO()
id := providers.NewProviderID("providerValue")

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

Example Usage: ProvidersClient.List

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: ProvidersClient.ListAtTenantScope

ctx := context.TODO()


// alternatively `client.ListAtTenantScope(ctx, providers.DefaultListAtTenantScopeOperationOptions())` can be used to do batched pagination
items, err := client.ListAtTenantScopeComplete(ctx, providers.DefaultListAtTenantScopeOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ProvidersClient.ProviderResourceTypesList

ctx := context.TODO()
id := providers.NewSubscriptionProviderID("12345678-1234-9876-4563-123456789012", "providerValue")

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

Example Usage: ProvidersClient.Register

ctx := context.TODO()
id := providers.NewSubscriptionProviderID("12345678-1234-9876-4563-123456789012", "providerValue")

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

Example Usage: ProvidersClient.RegisterAtManagementGroupScope

ctx := context.TODO()
id := providers.NewProviders2ID("groupIdValue", "providerValue")

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

Example Usage: ProvidersClient.Unregister

ctx := context.TODO()
id := providers.NewSubscriptionProviderID("12345678-1234-9876-4563-123456789012", "providerValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAliasPathAttributes 

func PossibleValuesForAliasPathAttributes() []string

func PossibleValuesForAliasPathTokenType 

func PossibleValuesForAliasPathTokenType() []string

func PossibleValuesForAliasPatternType 

func PossibleValuesForAliasPatternType() []string

func PossibleValuesForAliasType 

func PossibleValuesForAliasType() []string

func ValidateProviderID 

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

ValidateProviderID checks that 'input' can be parsed as a Provider ID

func ValidateProviders2ID 

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

ValidateProviders2ID checks that 'input' can be parsed as a Providers 2 ID

func ValidateSubscriptionProviderID 

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

ValidateSubscriptionProviderID checks that 'input' can be parsed as a Subscription Provider ID

Types

type Alias 

type Alias struct {
	DefaultMetadata *AliasPathMetadata `json:"defaultMetadata,omitempty"`
	DefaultPath     *string            `json:"defaultPath,omitempty"`
	DefaultPattern  *AliasPattern      `json:"defaultPattern,omitempty"`
	Name            *string            `json:"name,omitempty"`
	Paths           *[]AliasPath       `json:"paths,omitempty"`
	Type            *AliasType         `json:"type,omitempty"`
}

type AliasPath 

type AliasPath struct {
	ApiVersions *[]string          `json:"apiVersions,omitempty"`
	Metadata    *AliasPathMetadata `json:"metadata,omitempty"`
	Path        *string            `json:"path,omitempty"`
	Pattern     *AliasPattern      `json:"pattern,omitempty"`
}

type AliasPathAttributes 

type AliasPathAttributes string
const (
	AliasPathAttributesModifiable AliasPathAttributes = "Modifiable"
	AliasPathAttributesNone       AliasPathAttributes = "None"
)

func (*AliasPathAttributes) UnmarshalJSON 

func (s *AliasPathAttributes) UnmarshalJSON(bytes []byte) error

type AliasPathMetadata 

type AliasPathMetadata struct {
	Attributes *AliasPathAttributes `json:"attributes,omitempty"`
	Type       *AliasPathTokenType  `json:"type,omitempty"`
}

type AliasPathTokenType 

type AliasPathTokenType string
const (
	AliasPathTokenTypeAny          AliasPathTokenType = "Any"
	AliasPathTokenTypeArray        AliasPathTokenType = "Array"
	AliasPathTokenTypeBoolean      AliasPathTokenType = "Boolean"
	AliasPathTokenTypeInteger      AliasPathTokenType = "Integer"
	AliasPathTokenTypeNotSpecified AliasPathTokenType = "NotSpecified"
	AliasPathTokenTypeNumber       AliasPathTokenType = "Number"
	AliasPathTokenTypeObject       AliasPathTokenType = "Object"
	AliasPathTokenTypeString       AliasPathTokenType = "String"
)

func (*AliasPathTokenType) UnmarshalJSON 

func (s *AliasPathTokenType) UnmarshalJSON(bytes []byte) error

type AliasPattern 

type AliasPattern struct {
	Phrase   *string           `json:"phrase,omitempty"`
	Type     *AliasPatternType `json:"type,omitempty"`
	Variable *string           `json:"variable,omitempty"`
}

type AliasPatternType 

type AliasPatternType string
const (
	AliasPatternTypeExtract      AliasPatternType = "Extract"
	AliasPatternTypeNotSpecified AliasPatternType = "NotSpecified"
)

func (*AliasPatternType) UnmarshalJSON 

func (s *AliasPatternType) UnmarshalJSON(bytes []byte) error

type AliasType 

type AliasType string
const (
	AliasTypeMask         AliasType = "Mask"
	AliasTypeNotSpecified AliasType = "NotSpecified"
	AliasTypePlainText    AliasType = "PlainText"
)

func (*AliasType) UnmarshalJSON 

func (s *AliasType) UnmarshalJSON(bytes []byte) error

type ApiProfile 

type ApiProfile struct {
	ApiVersion     *string `json:"apiVersion,omitempty"`
	ProfileVersion *string `json:"profileVersion,omitempty"`
}

type GetAtTenantScopeOperationOptions 

type GetAtTenantScopeOperationOptions struct {
	Expand *string
}

func DefaultGetAtTenantScopeOperationOptions 

func DefaultGetAtTenantScopeOperationOptions() GetAtTenantScopeOperationOptions

func (GetAtTenantScopeOperationOptions) ToHeaders 

func (o GetAtTenantScopeOperationOptions) ToHeaders() *client.Headers

func (GetAtTenantScopeOperationOptions) ToOData 

func (o GetAtTenantScopeOperationOptions) ToOData() *odata.Query

func (GetAtTenantScopeOperationOptions) ToQuery 

func (o GetAtTenantScopeOperationOptions) ToQuery() *client.QueryParams

type GetAtTenantScopeOperationResponse 

type GetAtTenantScopeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Provider
}

type GetOperationOptions 

type GetOperationOptions struct {
	Expand *string
}

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        *Provider
}

type ListAtTenantScopeCompleteResult 

type ListAtTenantScopeCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Provider
}

type ListAtTenantScopeOperationOptions 

type ListAtTenantScopeOperationOptions struct {
	Expand *string
	Top    *int64
}

func DefaultListAtTenantScopeOperationOptions 

func DefaultListAtTenantScopeOperationOptions() ListAtTenantScopeOperationOptions

func (ListAtTenantScopeOperationOptions) ToHeaders 

func (o ListAtTenantScopeOperationOptions) ToHeaders() *client.Headers

func (ListAtTenantScopeOperationOptions) ToOData 

func (o ListAtTenantScopeOperationOptions) ToOData() *odata.Query

func (ListAtTenantScopeOperationOptions) ToQuery 

func (o ListAtTenantScopeOperationOptions) ToQuery() *client.QueryParams

type ListAtTenantScopeOperationResponse 

type ListAtTenantScopeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Provider
}

type ListCompleteResult 

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

type ListOperationOptions 

type ListOperationOptions struct {
	Expand *string
	Top    *int64
}

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

type Provider 

type Provider struct {
	Id                 *string                 `json:"id,omitempty"`
	Namespace          *string                 `json:"namespace,omitempty"`
	RegistrationPolicy *string                 `json:"registrationPolicy,omitempty"`
	RegistrationState  *string                 `json:"registrationState,omitempty"`
	ResourceTypes      *[]ProviderResourceType `json:"resourceTypes,omitempty"`
}

type ProviderExtendedLocation 

type ProviderExtendedLocation struct {
	ExtendedLocations *[]string `json:"extendedLocations,omitempty"`
	Location          *string   `json:"location,omitempty"`
	Type              *string   `json:"type,omitempty"`
}

type ProviderId 

type ProviderId struct {
	ProviderName string
}

ProviderId is a struct representing the Resource ID for a Provider

func NewProviderID 

func NewProviderID(providerName string) ProviderId

NewProviderID returns a new ProviderId struct

func ParseProviderID 

func ParseProviderID(input string) (*ProviderId, error)

ParseProviderID parses 'input' into a ProviderId

func ParseProviderIDInsensitively 

func ParseProviderIDInsensitively(input string) (*ProviderId, error)

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

func (*ProviderId) FromParseResult 

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

func (ProviderId) ID 

func (id ProviderId) ID() string

ID returns the formatted Provider ID

func (ProviderId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Provider ID

func (ProviderId) String 

func (id ProviderId) String() string

String returns a human-readable description of this Provider ID

type ProviderOperationPredicate 

type ProviderOperationPredicate struct {
	Id                 *string
	Namespace          *string
	RegistrationPolicy *string
	RegistrationState  *string
}

func (ProviderOperationPredicate) Matches 

func (p ProviderOperationPredicate) Matches(input Provider) bool

type ProviderResourceType 

type ProviderResourceType struct {
	Aliases           *[]Alias                    `json:"aliases,omitempty"`
	ApiProfiles       *[]ApiProfile               `json:"apiProfiles,omitempty"`
	ApiVersions       *[]string                   `json:"apiVersions,omitempty"`
	Capabilities      *string                     `json:"capabilities,omitempty"`
	DefaultApiVersion *string                     `json:"defaultApiVersion,omitempty"`
	LocationMappings  *[]ProviderExtendedLocation `json:"locationMappings,omitempty"`
	Locations         *[]string                   `json:"locations,omitempty"`
	Properties        *map[string]string          `json:"properties,omitempty"`
	ResourceType      *string                     `json:"resourceType,omitempty"`
	ZoneMappings      *[]ZoneMapping              `json:"zoneMappings,omitempty"`
}

type ProviderResourceTypeOperationPredicate added in v0.20240226.1173038 

type ProviderResourceTypeOperationPredicate struct {
	Capabilities      *string
	DefaultApiVersion *string
	ResourceType      *string
}

func (ProviderResourceTypeOperationPredicate) Matches added in v0.20240226.1173038 

func (p ProviderResourceTypeOperationPredicate) Matches(input ProviderResourceType) bool

type ProviderResourceTypesListCompleteResult added in v0.20240226.1173038 

type ProviderResourceTypesListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ProviderResourceType
}

type ProviderResourceTypesListOperationOptions 

type ProviderResourceTypesListOperationOptions struct {
	Expand *string
}

func DefaultProviderResourceTypesListOperationOptions 

func DefaultProviderResourceTypesListOperationOptions() ProviderResourceTypesListOperationOptions

func (ProviderResourceTypesListOperationOptions) ToHeaders 

func (o ProviderResourceTypesListOperationOptions) ToHeaders() *client.Headers

func (ProviderResourceTypesListOperationOptions) ToOData 

func (o ProviderResourceTypesListOperationOptions) ToOData() *odata.Query

func (ProviderResourceTypesListOperationOptions) ToQuery 

func (o ProviderResourceTypesListOperationOptions) ToQuery() *client.QueryParams

type ProviderResourceTypesListOperationResponse 

type ProviderResourceTypesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ProviderResourceType
}

type Providers2Id 

type Providers2Id struct {
	GroupId      string
	ProviderName string
}

Providers2Id is a struct representing the Resource ID for a Providers 2

func NewProviders2ID 

func NewProviders2ID(groupId string, providerName string) Providers2Id

NewProviders2ID returns a new Providers2Id struct

func ParseProviders2ID 

func ParseProviders2ID(input string) (*Providers2Id, error)

ParseProviders2ID parses 'input' into a Providers2Id

func ParseProviders2IDInsensitively 

func ParseProviders2IDInsensitively(input string) (*Providers2Id, error)

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

func (*Providers2Id) FromParseResult 

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

func (Providers2Id) ID 

func (id Providers2Id) ID() string

ID returns the formatted Providers 2 ID

func (Providers2Id) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Providers 2 ID

func (Providers2Id) String 

func (id Providers2Id) String() string

String returns a human-readable description of this Providers 2 ID

type ProvidersClient 

type ProvidersClient struct {
	Client *resourcemanager.Client
}

func NewProvidersClientWithBaseURI 

func NewProvidersClientWithBaseURI(sdkApi sdkEnv.Api) (*ProvidersClient, error)

func (ProvidersClient) Get 

func (c ProvidersClient) Get(ctx context.Context, id SubscriptionProviderId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (ProvidersClient) GetAtTenantScope 

func (c ProvidersClient) GetAtTenantScope(ctx context.Context, id ProviderId, options GetAtTenantScopeOperationOptions) (result GetAtTenantScopeOperationResponse, err error)

GetAtTenantScope ...

func (ProvidersClient) List 

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

List ...

func (ProvidersClient) ListAtTenantScope 

func (c ProvidersClient) ListAtTenantScope(ctx context.Context, options ListAtTenantScopeOperationOptions) (result ListAtTenantScopeOperationResponse, err error)

ListAtTenantScope ...

func (ProvidersClient) ListAtTenantScopeComplete 

func (c ProvidersClient) ListAtTenantScopeComplete(ctx context.Context, options ListAtTenantScopeOperationOptions) (ListAtTenantScopeCompleteResult, error)

ListAtTenantScopeComplete retrieves all the results into a single object

func (ProvidersClient) ListAtTenantScopeCompleteMatchingPredicate 

func (c ProvidersClient) ListAtTenantScopeCompleteMatchingPredicate(ctx context.Context, options ListAtTenantScopeOperationOptions, predicate ProviderOperationPredicate) (result ListAtTenantScopeCompleteResult, err error)

ListAtTenantScopeCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ProvidersClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (ProvidersClient) ListCompleteMatchingPredicate 

func (c ProvidersClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, predicate ProviderOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ProvidersClient) ProviderResourceTypesList 

func (c ProvidersClient) ProviderResourceTypesList(ctx context.Context, id SubscriptionProviderId, options ProviderResourceTypesListOperationOptions) (result ProviderResourceTypesListOperationResponse, err error)

ProviderResourceTypesList ...

func (ProvidersClient) ProviderResourceTypesListComplete added in v0.20240226.1173038 

func (c ProvidersClient) ProviderResourceTypesListComplete(ctx context.Context, id SubscriptionProviderId, options ProviderResourceTypesListOperationOptions) (ProviderResourceTypesListCompleteResult, error)

ProviderResourceTypesListComplete retrieves all the results into a single object

func (ProvidersClient) ProviderResourceTypesListCompleteMatchingPredicate added in v0.20240226.1173038 

func (c ProvidersClient) ProviderResourceTypesListCompleteMatchingPredicate(ctx context.Context, id SubscriptionProviderId, options ProviderResourceTypesListOperationOptions, predicate ProviderResourceTypeOperationPredicate) (result ProviderResourceTypesListCompleteResult, err error)

ProviderResourceTypesListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ProvidersClient) Register 

func (c ProvidersClient) Register(ctx context.Context, id SubscriptionProviderId) (result RegisterOperationResponse, err error)

Register ...

func (ProvidersClient) RegisterAtManagementGroupScope 

func (c ProvidersClient) RegisterAtManagementGroupScope(ctx context.Context, id Providers2Id) (result RegisterAtManagementGroupScopeOperationResponse, err error)

RegisterAtManagementGroupScope ...

func (ProvidersClient) Unregister 

func (c ProvidersClient) Unregister(ctx context.Context, id SubscriptionProviderId) (result UnregisterOperationResponse, err error)

Unregister ...

type RegisterAtManagementGroupScopeOperationResponse 

type RegisterAtManagementGroupScopeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type RegisterOperationResponse 

type RegisterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Provider
}

type SubscriptionProviderId 

type SubscriptionProviderId struct {
	SubscriptionId string
	ProviderName   string
}

SubscriptionProviderId is a struct representing the Resource ID for a Subscription Provider

func NewSubscriptionProviderID 

func NewSubscriptionProviderID(subscriptionId string, providerName string) SubscriptionProviderId

NewSubscriptionProviderID returns a new SubscriptionProviderId struct

func ParseSubscriptionProviderID 

func ParseSubscriptionProviderID(input string) (*SubscriptionProviderId, error)

ParseSubscriptionProviderID parses 'input' into a SubscriptionProviderId

func ParseSubscriptionProviderIDInsensitively 

func ParseSubscriptionProviderIDInsensitively(input string) (*SubscriptionProviderId, error)

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

func (*SubscriptionProviderId) FromParseResult 

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

func (SubscriptionProviderId) ID 

func (id SubscriptionProviderId) ID() string

ID returns the formatted Subscription Provider ID

func (SubscriptionProviderId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Subscription Provider ID

func (SubscriptionProviderId) String 

func (id SubscriptionProviderId) String() string

String returns a human-readable description of this Subscription Provider ID

type UnregisterOperationResponse 

type UnregisterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Provider
}

type ZoneMapping 

type ZoneMapping struct {
	Location *string       `json:"location,omitempty"`
	Zones    *zones.Schema `json:"zones,omitempty"`
}

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.