README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/resources/2020-06-01/providers
Documentation
The providers
SDK allows for interaction with the Azure Resource Manager Service resources
(API Version 2020-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/resources/2020-06-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 := providers.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.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 ¶
- func PossibleValuesForAliasPathAttributes() []string
- func PossibleValuesForAliasPathTokenType() []string
- func PossibleValuesForAliasPatternType() []string
- func PossibleValuesForAliasType() []string
- func ValidateProviderID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateProviders2ID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateSubscriptionProviderID(input interface{}, key string) (warnings []string, errors []error)
- type Alias
- type AliasPath
- type AliasPathAttributes
- type AliasPathMetadata
- type AliasPathTokenType
- type AliasPattern
- type AliasPatternType
- type AliasType
- type ApiProfile
- type GetAtTenantScopeOperationOptions
- type GetAtTenantScopeOperationResponse
- type GetOperationOptions
- type GetOperationResponse
- type ListAtTenantScopeCompleteResult
- type ListAtTenantScopeOperationOptions
- type ListAtTenantScopeOperationResponse
- type ListCompleteResult
- type ListOperationOptions
- type ListOperationResponse
- type Provider
- type ProviderId
- type ProviderOperationPredicate
- type ProviderResourceType
- type Providers2Id
- type ProvidersClient
- func (c ProvidersClient) Get(ctx context.Context, id SubscriptionProviderId, options GetOperationOptions) (result GetOperationResponse, err error)
- func (c ProvidersClient) GetAtTenantScope(ctx context.Context, id ProviderId, options GetAtTenantScopeOperationOptions) (result GetAtTenantScopeOperationResponse, err error)
- func (c ProvidersClient) List(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (resp ListOperationResponse, err error)
- func (c ProvidersClient) ListAtTenantScope(ctx context.Context, options ListAtTenantScopeOperationOptions) (resp ListAtTenantScopeOperationResponse, err error)
- func (c ProvidersClient) ListAtTenantScopeComplete(ctx context.Context, options ListAtTenantScopeOperationOptions) (ListAtTenantScopeCompleteResult, error)
- func (c ProvidersClient) ListAtTenantScopeCompleteMatchingPredicate(ctx context.Context, options ListAtTenantScopeOperationOptions, ...) (resp ListAtTenantScopeCompleteResult, err error)
- func (c ProvidersClient) ListComplete(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (ListCompleteResult, error)
- func (c ProvidersClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, ...) (resp ListCompleteResult, err error)
- func (c ProvidersClient) Register(ctx context.Context, id SubscriptionProviderId) (result RegisterOperationResponse, err error)
- func (c ProvidersClient) RegisterAtManagementGroupScope(ctx context.Context, id Providers2Id) (result RegisterAtManagementGroupScopeOperationResponse, err error)
- func (c ProvidersClient) Unregister(ctx context.Context, id SubscriptionProviderId) (result UnregisterOperationResponse, err error)
- type RegisterAtManagementGroupScopeOperationResponse
- type RegisterOperationResponse
- type SubscriptionProviderId
- type UnregisterOperationResponse
- type ZoneMapping
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 ¶
ValidateProviderID checks that 'input' can be parsed as a Provider ID
func ValidateProviders2ID ¶
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" )
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" )
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" )
type ApiProfile ¶
type GetAtTenantScopeOperationOptions ¶
type GetAtTenantScopeOperationOptions struct {
Expand *string
}
func DefaultGetAtTenantScopeOperationOptions ¶
func DefaultGetAtTenantScopeOperationOptions() GetAtTenantScopeOperationOptions
type GetOperationOptions ¶
type GetOperationOptions struct {
Expand *string
}
func DefaultGetOperationOptions ¶
func DefaultGetOperationOptions() GetOperationOptions
type GetOperationResponse ¶
type ListAtTenantScopeCompleteResult ¶
type ListAtTenantScopeCompleteResult struct {
Items []Provider
}
type ListAtTenantScopeOperationOptions ¶
func DefaultListAtTenantScopeOperationOptions ¶
func DefaultListAtTenantScopeOperationOptions() ListAtTenantScopeOperationOptions
type ListAtTenantScopeOperationResponse ¶
type ListAtTenantScopeOperationResponse struct { HttpResponse *http.Response Model *[]Provider // contains filtered or unexported fields }
func (ListAtTenantScopeOperationResponse) HasMore ¶
func (r ListAtTenantScopeOperationResponse) HasMore() bool
func (ListAtTenantScopeOperationResponse) LoadMore ¶
func (r ListAtTenantScopeOperationResponse) LoadMore(ctx context.Context) (resp ListAtTenantScopeOperationResponse, err error)
type ListCompleteResult ¶
type ListCompleteResult struct {
Items []Provider
}
type ListOperationOptions ¶
func DefaultListOperationOptions ¶
func DefaultListOperationOptions() ListOperationOptions
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response Model *[]Provider // 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 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 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) 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"` Locations *[]string `json:"locations,omitempty"` Properties *map[string]string `json:"properties,omitempty"` ResourceType *string `json:"resourceType,omitempty"` ZoneMappings *[]ZoneMapping `json:"zoneMappings,omitempty"` }
type Providers2Id ¶
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) 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 ¶
func NewProvidersClientWithBaseURI ¶
func NewProvidersClientWithBaseURI(endpoint string) ProvidersClient
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) (resp ListOperationResponse, err error)
List ...
func (ProvidersClient) ListAtTenantScope ¶
func (c ProvidersClient) ListAtTenantScope(ctx context.Context, options ListAtTenantScopeOperationOptions) (resp ListAtTenantScopeOperationResponse, err error)
ListAtTenantScope ...
func (ProvidersClient) ListAtTenantScopeComplete ¶
func (c ProvidersClient) ListAtTenantScopeComplete(ctx context.Context, options ListAtTenantScopeOperationOptions) (ListAtTenantScopeCompleteResult, error)
ListAtTenantScopeComplete retrieves all of the results into a single object
func (ProvidersClient) ListAtTenantScopeCompleteMatchingPredicate ¶
func (c ProvidersClient) ListAtTenantScopeCompleteMatchingPredicate(ctx context.Context, options ListAtTenantScopeOperationOptions, predicate ProviderOperationPredicate) (resp ListAtTenantScopeCompleteResult, err error)
ListAtTenantScopeCompleteMatchingPredicate retrieves all of the results and then applied the predicate
func (ProvidersClient) ListComplete ¶
func (c ProvidersClient) ListComplete(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (ListCompleteResult, error)
ListComplete retrieves all of the results into a single object
func (ProvidersClient) ListCompleteMatchingPredicate ¶
func (c ProvidersClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, predicate ProviderOperationPredicate) (resp ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all of the results and then applied 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 SubscriptionProviderId ¶
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) 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 ZoneMapping ¶
Source Files ¶
- client.go
- constants.go
- id_provider.go
- id_providers2.go
- id_subscriptionprovider.go
- method_get_autorest.go
- method_getattenantscope_autorest.go
- method_list_autorest.go
- method_listattenantscope_autorest.go
- method_register_autorest.go
- method_registeratmanagementgroupscope_autorest.go
- method_unregister_autorest.go
- model_alias.go
- model_aliaspath.go
- model_aliaspathmetadata.go
- model_aliaspattern.go
- model_apiprofile.go
- model_provider.go
- model_providerresourcetype.go
- model_zonemapping.go
- predicates.go
- version.go