package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev
# 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
}
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewProviderID returns a new ProviderId struct.
NewProviders2ID returns a new Providers2Id struct.
No description provided by the author
NewSubscriptionProviderID returns a new SubscriptionProviderId struct.
ParseProviderID parses 'input' into a ProviderId.
ParseProviderIDInsensitively parses 'input' case-insensitively into a ProviderId note: this method should only be used for API response data and not user input.
ParseProviders2ID parses 'input' into a Providers2Id.
ParseProviders2IDInsensitively parses 'input' case-insensitively into a Providers2Id note: this method should only be used for API response data and not user input.
ParseSubscriptionProviderID parses 'input' into a SubscriptionProviderId.
ParseSubscriptionProviderIDInsensitively parses 'input' case-insensitively into a SubscriptionProviderId note: this method should only be used for API response data and not user input.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ValidateProviderID checks that 'input' can be parsed as a Provider ID.
ValidateProviders2ID checks that 'input' can be parsed as a Providers 2 ID.
ValidateSubscriptionProviderID checks that 'input' can be parsed as a Subscription Provider ID.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ProviderId is a struct representing the Resource ID for a Provider.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Providers2Id is a struct representing the Resource ID for a Providers 2.
No description provided by the author
No description provided by the author
No description provided by the author
SubscriptionProviderId is a struct representing the Resource ID for a Subscription Provider.
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author