location

package
v14.3.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Mar 9, 2018 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package location implements the Azure ARM Location service API version 2017-01-01-preview.

Resource Provider

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Location
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AccountsClient 

type AccountsClient struct {
	BaseClient
}

AccountsClient is the resource Provider

func NewAccountsClient 

func NewAccountsClient(subscriptionID string) AccountsClient

NewAccountsClient creates an instance of the AccountsClient client.

func NewAccountsClientWithBaseURI 

func NewAccountsClientWithBaseURI(baseURI string, subscriptionID string) AccountsClient

NewAccountsClientWithBaseURI creates an instance of the AccountsClient client.

func (AccountsClient) CreateOrUpdate 

func (client AccountsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, locationBasedServicesAccountCreateParameters BasedServicesAccountCreateParameters) (result BasedServicesAccount, err error)

CreateOrUpdate create or update a Location Based Services Account. A Location Based Services Account holds the keys which allow access to the Location Based Services REST APIs.

resourceGroupName is the name of the Azure Resource Group. accountName is the name of the Location Based Services Account. locationBasedServicesAccountCreateParameters is the new or updated parameters for the Location Based Services Account.

func (AccountsClient) CreateOrUpdatePreparer 

func (client AccountsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, locationBasedServicesAccountCreateParameters BasedServicesAccountCreateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AccountsClient) CreateOrUpdateResponder 

func (client AccountsClient) CreateOrUpdateResponder(resp *http.Response) (result BasedServicesAccount, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (AccountsClient) CreateOrUpdateSender 

func (client AccountsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) Delete 

func (client AccountsClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result autorest.Response, err error)

Delete delete a Location Based Services Account

resourceGroupName is the name of the Azure Resource Group. accountName is the name of the Location Based Services Account.

func (AccountsClient) DeletePreparer 

func (client AccountsClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (AccountsClient) DeleteResponder 

func (client AccountsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (AccountsClient) DeleteSender 

func (client AccountsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) Get 

func (client AccountsClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result BasedServicesAccount, err error)

Get get a Location Based Services Account

resourceGroupName is the name of the Azure Resource Group. accountName is the name of the Location Based Services Account.

func (AccountsClient) GetPreparer 

func (client AccountsClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AccountsClient) GetResponder 

func (client AccountsClient) GetResponder(resp *http.Response) (result BasedServicesAccount, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (AccountsClient) GetSender 

func (client AccountsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) ListByResourceGroup 

func (client AccountsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result BasedServicesAccounts, err error)

ListByResourceGroup get all Location Based Services Accounts in a Resource Group

resourceGroupName is the name of the Azure Resource Group.

func (AccountsClient) ListByResourceGroupPreparer 

func (client AccountsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (AccountsClient) ListByResourceGroupResponder 

func (client AccountsClient) ListByResourceGroupResponder(resp *http.Response) (result BasedServicesAccounts, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (AccountsClient) ListByResourceGroupSender 

func (client AccountsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) ListBySubscription 

func (client AccountsClient) ListBySubscription(ctx context.Context) (result BasedServicesAccounts, err error)

ListBySubscription get all Location Based Services Accounts in a Subscription

func (AccountsClient) ListBySubscriptionPreparer 

func (client AccountsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (AccountsClient) ListBySubscriptionResponder 

func (client AccountsClient) ListBySubscriptionResponder(resp *http.Response) (result BasedServicesAccounts, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (AccountsClient) ListBySubscriptionSender 

func (client AccountsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) ListKeys 

func (client AccountsClient) ListKeys(ctx context.Context, resourceGroupName string, accountName string) (result BasedServicesAccountKeys, err error)

ListKeys get the keys to use with the Location Based Services APIs. A key is used to authenticate and authorize access to the Location Based Services REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.

resourceGroupName is the name of the Azure Resource Group. accountName is the name of the Location Based Services Account.

func (AccountsClient) ListKeysPreparer 

func (client AccountsClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (AccountsClient) ListKeysResponder 

func (client AccountsClient) ListKeysResponder(resp *http.Response) (result BasedServicesAccountKeys, err error)

ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.

func (AccountsClient) ListKeysSender 

func (client AccountsClient) ListKeysSender(req *http.Request) (*http.Response, error)

ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) ListOperations 

func (client AccountsClient) ListOperations(ctx context.Context) (result BasedServicesOperations, err error)

ListOperations list operations available for the Location Based Services Resource Provider

func (AccountsClient) ListOperationsPreparer 

func (client AccountsClient) ListOperationsPreparer(ctx context.Context) (*http.Request, error)

ListOperationsPreparer prepares the ListOperations request.

func (AccountsClient) ListOperationsResponder 

func (client AccountsClient) ListOperationsResponder(resp *http.Response) (result BasedServicesOperations, err error)

ListOperationsResponder handles the response to the ListOperations request. The method always closes the http.Response Body.

func (AccountsClient) ListOperationsSender 

func (client AccountsClient) ListOperationsSender(req *http.Request) (*http.Response, error)

ListOperationsSender sends the ListOperations request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) Move 

func (client AccountsClient) Move(ctx context.Context, resourceGroupName string, moveRequest BasedServicesAccountsMoveRequest) (result autorest.Response, err error)

Move moves Location Based Services Accounts from one ResourceGroup (or Subscription) to another

resourceGroupName is the name of the resource group that contains Location Based Services Account to move. moveRequest is the details of the Location Based Services Account move.

func (AccountsClient) MovePreparer 

func (client AccountsClient) MovePreparer(ctx context.Context, resourceGroupName string, moveRequest BasedServicesAccountsMoveRequest) (*http.Request, error)

MovePreparer prepares the Move request.

func (AccountsClient) MoveResponder 

func (client AccountsClient) MoveResponder(resp *http.Response) (result autorest.Response, err error)

MoveResponder handles the response to the Move request. The method always closes the http.Response Body.

func (AccountsClient) MoveSender 

func (client AccountsClient) MoveSender(req *http.Request) (*http.Response, error)

MoveSender sends the Move request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) RegenerateKeys 

func (client AccountsClient) RegenerateKeys(ctx context.Context, resourceGroupName string, accountName string, keySpecification BasedServicesKeySpecification) (result BasedServicesAccountKeys, err error)

RegenerateKeys regenerate either the primary or secondary key for use with the Location Based Services APIs. The old key will stop working immediately.

resourceGroupName is the name of the Azure Resource Group. accountName is the name of the Location Based Services Account. keySpecification is which key to regenerate: primary or secondary.

func (AccountsClient) RegenerateKeysPreparer 

func (client AccountsClient) RegenerateKeysPreparer(ctx context.Context, resourceGroupName string, accountName string, keySpecification BasedServicesKeySpecification) (*http.Request, error)

RegenerateKeysPreparer prepares the RegenerateKeys request.

func (AccountsClient) RegenerateKeysResponder 

func (client AccountsClient) RegenerateKeysResponder(resp *http.Response) (result BasedServicesAccountKeys, err error)

RegenerateKeysResponder handles the response to the RegenerateKeys request. The method always closes the http.Response Body.

func (AccountsClient) RegenerateKeysSender 

func (client AccountsClient) RegenerateKeysSender(req *http.Request) (*http.Response, error)

RegenerateKeysSender sends the RegenerateKeys request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) Update 

func (client AccountsClient) Update(ctx context.Context, resourceGroupName string, accountName string, locationBasedServicesAccountUpdateParameters BasedServicesAccountUpdateParameters) (result BasedServicesAccount, err error)

Update updates a Location Based Services Account. Only a subset of the parameters may be updated after creation, such as Sku and Tags.

resourceGroupName is the name of the Azure Resource Group. accountName is the name of the Location Based Services Account. locationBasedServicesAccountUpdateParameters is the updated parameters for the Location Based Services Account.

func (AccountsClient) UpdatePreparer 

func (client AccountsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, locationBasedServicesAccountUpdateParameters BasedServicesAccountUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (AccountsClient) UpdateResponder 

func (client AccountsClient) UpdateResponder(resp *http.Response) (result BasedServicesAccount, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (AccountsClient) UpdateSender 

func (client AccountsClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Location.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type BasedServicesAccount 

type BasedServicesAccount struct {
	autorest.Response `json:"-"`
	// LocationProperty - The location of the resource.
	LocationProperty *string `json:"location,omitempty"`
	// Tags - Gets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.
	Tags map[string]*string `json:"tags"`
	// Sku - The SKU of this account.
	Sku *Sku `json:"sku,omitempty"`
	// ID - The fully qualified Location Based Services Account resource identifier.
	ID *string `json:"id,omitempty"`
	// Name - The name of the Location Based Services Account, which is unique within a Resource Group.
	Name *string `json:"name,omitempty"`
	// Type - Azure resource type.
	Type *string `json:"type,omitempty"`
}

BasedServicesAccount an Azure resource which represents access to a suite of Location Based Services REST APIs.

func (BasedServicesAccount) MarshalJSON 

func (bsa BasedServicesAccount) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BasedServicesAccount.

type BasedServicesAccountCreateParameters 

type BasedServicesAccountCreateParameters struct {
	// LocationProperty - The location of the resource.
	LocationProperty *string `json:"location,omitempty"`
	// Tags - Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.
	Tags map[string]*string `json:"tags"`
	// Sku - The SKU of this account.
	Sku *Sku `json:"sku,omitempty"`
}

BasedServicesAccountCreateParameters parameters used to create a new Location Based Services Account.

func (BasedServicesAccountCreateParameters) MarshalJSON 

func (bsacp BasedServicesAccountCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BasedServicesAccountCreateParameters.

type BasedServicesAccountKeys 

type BasedServicesAccountKeys struct {
	autorest.Response `json:"-"`
	// ID - The full Azure resource identifier of the Location Based Services Account.
	ID *string `json:"id,omitempty"`
	// PrimaryKey - The primary key for accessing the Location Based Services REST APIs.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - The secondary key for accessing the Location Based Services REST APIs.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

BasedServicesAccountKeys the set of keys which can be used to access the Location Based Services REST APIs. Two keys are provided for key rotation without interruption.

type BasedServicesAccountUpdateParameters 

type BasedServicesAccountUpdateParameters struct {
	// Tags - Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.
	Tags map[string]*string `json:"tags"`
	// Sku - The SKU of this account.
	Sku *Sku `json:"sku,omitempty"`
}

BasedServicesAccountUpdateParameters parameters used to update an existing Location Based Services Account.

func (BasedServicesAccountUpdateParameters) MarshalJSON 

func (bsaup BasedServicesAccountUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BasedServicesAccountUpdateParameters.

type BasedServicesAccounts 

type BasedServicesAccounts struct {
	autorest.Response `json:"-"`
	// Value - A Location Based Services Account.
	Value *[]BasedServicesAccount `json:"value,omitempty"`
}

BasedServicesAccounts a list of Location Based Services Accounts.

type BasedServicesAccountsMoveRequest 

type BasedServicesAccountsMoveRequest struct {
	// TargetResourceGroup - The name of the destination resource group.
	TargetResourceGroup *string `json:"targetResourceGroup,omitempty"`
	// ResourceIds - A list of resource names to move from the source resource group.
	ResourceIds *[]string `json:"resourceIds,omitempty"`
}

BasedServicesAccountsMoveRequest the description of what resources to move between resource groups.

type BasedServicesKeySpecification 

type BasedServicesKeySpecification struct {
	// KeyType - Whether the operation refers to the primary or secondary key. Possible values include: 'Primary', 'Secondary'
	KeyType KeyType `json:"keyType,omitempty"`
}

BasedServicesKeySpecification whether the operation refers to the primary or secondary key.

type BasedServicesOperations 

type BasedServicesOperations struct {
	autorest.Response `json:"-"`
	// Value - An operation available for Location Based Services.
	Value *[]BasedServicesOperationsValueItem `json:"value,omitempty"`
}

BasedServicesOperations the set of operations available for Location Based Services.

type BasedServicesOperationsValueItem 

type BasedServicesOperationsValueItem struct {
	// Name - Operation name: {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`
	// Display - The human-readable description of the operation.
	Display *BasedServicesOperationsValueItemDisplay `json:"display,omitempty"`
	// Origin - The origin of the operation.
	Origin *string `json:"origin,omitempty"`
}

BasedServicesOperationsValueItem ...

type BasedServicesOperationsValueItemDisplay 

type BasedServicesOperationsValueItemDisplay struct {
	// Provider - Service provider: Microsoft Location Based Services.
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
	// Operation - The action that users can perform, based on their permission level.
	Operation *string `json:"operation,omitempty"`
	// Description - The description of the operation.
	Description *string `json:"description,omitempty"`
}

BasedServicesOperationsValueItemDisplay the human-readable description of the operation.

type Error 

type Error struct {
	// Code - Error code.
	Code *string `json:"code,omitempty"`
	// Message - If available, a human readable description of the error.
	Message *string `json:"message,omitempty"`
	// Target - If available, the component generating the error.
	Target *string `json:"target,omitempty"`
	// Details - If available, a list of additional details about the error.
	Details *[]ErrorDetailsItem `json:"details,omitempty"`
}

Error this object is returned when an error occurs in the Location Based Service API

type ErrorDetailsItem 

type ErrorDetailsItem struct {
	// Code - Error code.
	Code *string `json:"code,omitempty"`
	// Message - If available, a human readable description of the error.
	Message *string `json:"message,omitempty"`
	// Target - If available, the component generating the error.
	Target *string `json:"target,omitempty"`
}

ErrorDetailsItem ...

type KeyType 

type KeyType string

KeyType enumerates the values for key type. 

const (
	// Primary ...
	Primary KeyType = "primary"
	// Secondary ...
	Secondary KeyType = "secondary"
)

type Resource 

type Resource struct {
	// ID - The fully qualified Location Based Services Account resource identifier.
	ID *string `json:"id,omitempty"`
	// Name - The name of the Location Based Services Account, which is unique within a Resource Group.
	Name *string `json:"name,omitempty"`
	// Type - Azure resource type.
	Type *string `json:"type,omitempty"`
}

Resource an Azure resource

type Sku 

type Sku struct {
	// Name - The name of the SKU, in standard format (such as S0).
	Name *string `json:"name,omitempty"`
	// Tier - Gets the sku tier. This is based on the SKU name.
	Tier *string `json:"tier,omitempty"`
}

Sku the SKU of the Location Based Services Account.

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.