operations

README

github.com/hashicorp/go-azure-sdk/resource-manager/appconfiguration/2023-03-01/operations Documentation

The operations SDK allows for interaction with Azure Resource Manager appconfiguration (API Version 2023-03-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/appconfiguration/2023-03-01/operations"

Client Initialization

client := operations.NewOperationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OperationsClient.CheckNameAvailability

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

payload := operations.CheckNameAvailabilityParameters{
	// ...
}


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

Example Usage: OperationsClient.RegionalCheckNameAvailability

ctx := context.TODO()
id := operations.NewLocationID("12345678-1234-9876-4563-123456789012", "locationName")

payload := operations.CheckNameAvailabilityParameters{
	// ...
}


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

Documentation

Index

• func PossibleValuesForConfigurationResourceType() []string
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type CheckNameAvailabilityOperationResponse
• type CheckNameAvailabilityParameters
• type ConfigurationResourceType
  • func (s *ConfigurationResourceType) UnmarshalJSON(bytes []byte) error
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type NameAvailabilityStatus
• type OperationsClient
  • func NewOperationsClientWithBaseURI(sdkApi sdkEnv.Api) (*OperationsClient, error)
  • func (c OperationsClient) CheckNameAvailability(ctx context.Context, id commonids.SubscriptionId, ...) (result CheckNameAvailabilityOperationResponse, err error)
  • func (c OperationsClient) RegionalCheckNameAvailability(ctx context.Context, id LocationId, input CheckNameAvailabilityParameters) (result RegionalCheckNameAvailabilityOperationResponse, err error)
• type RegionalCheckNameAvailabilityOperationResponse

Functions

func PossibleValuesForConfigurationResourceType

func PossibleValuesForConfigurationResourceType() []string

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type CheckNameAvailabilityOperationResponse

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NameAvailabilityStatus
}

type CheckNameAvailabilityParameters

type CheckNameAvailabilityParameters struct {
	Name string                    `json:"name"`
	Type ConfigurationResourceType `json:"type"`
}

type ConfigurationResourceType

type ConfigurationResourceType string

const (
	ConfigurationResourceTypeMicrosoftPointAppConfigurationConfigurationStores ConfigurationResourceType = "Microsoft.AppConfiguration/configurationStores"
)

func (*ConfigurationResourceType) UnmarshalJSON

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

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

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

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type NameAvailabilityStatus

type NameAvailabilityStatus struct {
	Message       *string `json:"message,omitempty"`
	NameAvailable *bool   `json:"nameAvailable,omitempty"`
	Reason        *string `json:"reason,omitempty"`
}

type OperationsClient

type OperationsClient struct {
	Client *resourcemanager.Client
}

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(sdkApi sdkEnv.Api) (*OperationsClient, error)

func (OperationsClient) CheckNameAvailability

func (c OperationsClient) CheckNameAvailability(ctx context.Context, id commonids.SubscriptionId, input CheckNameAvailabilityParameters) (result CheckNameAvailabilityOperationResponse, err error)

CheckNameAvailability ...

func (OperationsClient) RegionalCheckNameAvailability

func (c OperationsClient) RegionalCheckNameAvailability(ctx context.Context, id LocationId, input CheckNameAvailabilityParameters) (result RegionalCheckNameAvailabilityOperationResponse, err error)

RegionalCheckNameAvailability ...

type RegionalCheckNameAvailabilityOperationResponse

type RegionalCheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NameAvailabilityStatus
}