locations

README

github.com/hashicorp/go-azure-sdk/resource-manager/datalakestore/2016-11-01/locations Documentation

The locations SDK allows for interaction with the Azure Resource Manager Service datalakestore (API Version 2016-11-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/datalakestore/2016-11-01/locations"

Client Initialization

client := locations.NewLocationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: LocationsClient.GetCapability

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

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

Documentation

Index

• func PossibleValuesForSubscriptionState() []string
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type CapabilityInformation
• type GetCapabilityOperationResponse
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type LocationsClient
  • func NewLocationsClientWithBaseURI(endpoint string) LocationsClient
  • func (c LocationsClient) GetCapability(ctx context.Context, id LocationId) (result GetCapabilityOperationResponse, err error)
• type SubscriptionState

Functions

func PossibleValuesForSubscriptionState

func PossibleValuesForSubscriptionState() []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 CapabilityInformation

type CapabilityInformation struct {
	AccountCount    *int64             `json:"accountCount,omitempty"`
	MaxAccountCount *int64             `json:"maxAccountCount,omitempty"`
	MigrationState  *bool              `json:"migrationState,omitempty"`
	State           *SubscriptionState `json:"state,omitempty"`
	SubscriptionId  *string            `json:"subscriptionId,omitempty"`
}

type GetCapabilityOperationResponse

type GetCapabilityOperationResponse struct {
	HttpResponse *http.Response
	Model        *CapabilityInformation
}

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) 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 LocationsClient

type LocationsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewLocationsClientWithBaseURI

func NewLocationsClientWithBaseURI(endpoint string) LocationsClient

func (LocationsClient) GetCapability

func (c LocationsClient) GetCapability(ctx context.Context, id LocationId) (result GetCapabilityOperationResponse, err error)

GetCapability ...

type SubscriptionState

type SubscriptionState string

const (
	SubscriptionStateDeleted      SubscriptionState = "Deleted"
	SubscriptionStateRegistered   SubscriptionState = "Registered"
	SubscriptionStateSuspended    SubscriptionState = "Suspended"
	SubscriptionStateUnregistered SubscriptionState = "Unregistered"
	SubscriptionStateWarned       SubscriptionState = "Warned"
)