const (
// DefaultBaseURI is the default URI used for the service Maps
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Account an Azure resource which represents access to a suite of Maps REST APIs.
type Account struct {
autorest.Response `json:"-"`
// Location - READ-ONLY; The location of the resource.
Location *string `json:"location,omitempty"`
// Tags - READ-ONLY; 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 - READ-ONLY; The SKU of this account.
Sku *Sku `json:"sku,omitempty"`
// Properties - READ-ONLY; The map account properties.
Properties *AccountProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The fully qualified Maps Account resource identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the Maps Account, which is unique within a Resource Group.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Azure resource type.
Type *string `json:"type,omitempty"`
}
func (a Account) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Account.
AccountCreateParameters parameters used to create a new Maps Account.
type AccountCreateParameters struct {
// Location - The location of the resource.
Location *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"`
}
func (acp AccountCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccountCreateParameters.
AccountKeys the set of keys which can be used to access the Maps REST APIs. Two keys are provided for key rotation without interruption.
type AccountKeys struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; The full Azure resource identifier of the Maps Account.
ID *string `json:"id,omitempty"`
// PrimaryKey - READ-ONLY; The primary key for accessing the Maps REST APIs.
PrimaryKey *string `json:"primaryKey,omitempty"`
// SecondaryKey - READ-ONLY; The secondary key for accessing the Maps REST APIs.
SecondaryKey *string `json:"secondaryKey,omitempty"`
}
func (ak AccountKeys) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccountKeys.
AccountProperties additional Map account properties
type AccountProperties struct {
// XMsClientID - A unique identifier for the maps account
XMsClientID *string `json:"x-ms-client-id,omitempty"`
}
AccountUpdateParameters parameters used to update an existing Maps Account.
type AccountUpdateParameters 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"`
}
func (aup AccountUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccountUpdateParameters.
Accounts a list of Maps Accounts.
type Accounts struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; a Maps Account.
Value *[]Account `json:"value,omitempty"`
}
func (a Accounts) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Accounts.
AccountsClient is the resource Provider
type AccountsClient struct {
BaseClient
}
func NewAccountsClient(subscriptionID string) AccountsClient
NewAccountsClient creates an instance of the AccountsClient client.
func NewAccountsClientWithBaseURI(baseURI string, subscriptionID string) AccountsClient
NewAccountsClientWithBaseURI creates an instance of the AccountsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client AccountsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, mapsAccountCreateParameters AccountCreateParameters) (result Account, err error)
CreateOrUpdate create or update a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs. Parameters: resourceGroupName - the name of the Azure Resource Group. accountName - the name of the Maps Account. mapsAccountCreateParameters - the new or updated parameters for the Maps Account.
func (client AccountsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, mapsAccountCreateParameters AccountCreateParameters) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client AccountsClient) CreateOrUpdateResponder(resp *http.Response) (result Account, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
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 (client AccountsClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result autorest.Response, err error)
Delete delete a Maps Account. Parameters: resourceGroupName - the name of the Azure Resource Group. accountName - the name of the Maps Account.
func (client AccountsClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (client AccountsClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result Account, err error)
Get get a Maps Account. Parameters: resourceGroupName - the name of the Azure Resource Group. accountName - the name of the Maps Account.
func (client AccountsClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client AccountsClient) GetResponder(resp *http.Response) (result Account, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
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 (client AccountsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result Accounts, err error)
ListByResourceGroup get all Maps Accounts in a Resource Group Parameters: resourceGroupName - the name of the Azure Resource Group.
func (client AccountsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client AccountsClient) ListByResourceGroupResponder(resp *http.Response) (result Accounts, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
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 (client AccountsClient) ListBySubscription(ctx context.Context) (result Accounts, err error)
ListBySubscription get all Maps Accounts in a Subscription
func (client AccountsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client AccountsClient) ListBySubscriptionResponder(resp *http.Response) (result Accounts, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
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 (client AccountsClient) ListKeys(ctx context.Context, resourceGroupName string, accountName string) (result AccountKeys, err error)
ListKeys get the keys to use with the Maps APIs. A key is used to authenticate and authorize access to the Maps REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration. Parameters: resourceGroupName - the name of the Azure Resource Group. accountName - the name of the Maps Account.
func (client AccountsClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListKeysPreparer prepares the ListKeys request.
func (client AccountsClient) ListKeysResponder(resp *http.Response) (result AccountKeys, err error)
ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.
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 (client AccountsClient) ListOperations(ctx context.Context) (result Operations, err error)
ListOperations list operations available for the Maps Resource Provider
func (client AccountsClient) ListOperationsPreparer(ctx context.Context) (*http.Request, error)
ListOperationsPreparer prepares the ListOperations request.
func (client AccountsClient) ListOperationsResponder(resp *http.Response) (result Operations, err error)
ListOperationsResponder handles the response to the ListOperations request. The method always closes the http.Response Body.
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 (client AccountsClient) Move(ctx context.Context, resourceGroupName string, moveRequest AccountsMoveRequest) (result autorest.Response, err error)
Move moves Maps Accounts from one ResourceGroup (or Subscription) to another Parameters: resourceGroupName - the name of the resource group that contains Maps Account to move. moveRequest - the details of the Maps Account move.
func (client AccountsClient) MovePreparer(ctx context.Context, resourceGroupName string, moveRequest AccountsMoveRequest) (*http.Request, error)
MovePreparer prepares the Move request.
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 (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 (client AccountsClient) RegenerateKeys(ctx context.Context, resourceGroupName string, accountName string, keySpecification KeySpecification) (result AccountKeys, err error)
RegenerateKeys regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately. Parameters: resourceGroupName - the name of the Azure Resource Group. accountName - the name of the Maps Account. keySpecification - which key to regenerate: primary or secondary.
func (client AccountsClient) RegenerateKeysPreparer(ctx context.Context, resourceGroupName string, accountName string, keySpecification KeySpecification) (*http.Request, error)
RegenerateKeysPreparer prepares the RegenerateKeys request.
func (client AccountsClient) RegenerateKeysResponder(resp *http.Response) (result AccountKeys, err error)
RegenerateKeysResponder handles the response to the RegenerateKeys request. The method always closes the http.Response Body.
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 (client AccountsClient) Update(ctx context.Context, resourceGroupName string, accountName string, mapsAccountUpdateParameters AccountUpdateParameters) (result Account, err error)
Update updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku and Tags. Parameters: resourceGroupName - the name of the Azure Resource Group. accountName - the name of the Maps Account. mapsAccountUpdateParameters - the updated parameters for the Maps Account.
func (client AccountsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, mapsAccountUpdateParameters AccountUpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client AccountsClient) UpdateResponder(resp *http.Response) (result Account, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
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.
AccountsMoveRequest the description of what resources to move between resource groups.
type AccountsMoveRequest 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"`
}
BaseClient is the base client for Maps.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
Error this object is returned when an error occurs in the Maps API
type Error struct {
// Code - READ-ONLY; Error code.
Code *string `json:"code,omitempty"`
// Message - READ-ONLY; If available, a human readable description of the error.
Message *string `json:"message,omitempty"`
// Target - READ-ONLY; If available, the component generating the error.
Target *string `json:"target,omitempty"`
// Details - READ-ONLY; If available, a list of additional details about the error.
Details *[]ErrorDetailsItem `json:"details,omitempty"`
}
func (e Error) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Error.
ErrorDetailsItem ...
type ErrorDetailsItem struct {
// Code - READ-ONLY; Error code.
Code *string `json:"code,omitempty"`
// Message - READ-ONLY; If available, a human readable description of the error.
Message *string `json:"message,omitempty"`
// Target - READ-ONLY; If available, the component generating the error.
Target *string `json:"target,omitempty"`
}
func (eI ErrorDetailsItem) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorDetailsItem.
KeySpecification whether the operation refers to the primary or secondary key.
type KeySpecification struct {
// KeyType - Whether the operation refers to the primary or secondary key. Possible values include: 'Primary', 'Secondary'
KeyType KeyType `json:"keyType,omitempty"`
}
KeyType enumerates the values for key type.
type KeyType string
const (
// Primary ...
Primary KeyType = "primary"
// Secondary ...
Secondary KeyType = "secondary"
)
func PossibleKeyTypeValues() []KeyType
PossibleKeyTypeValues returns an array of possible values for the KeyType const type.
Operations the set of operations available for Maps.
type Operations struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; An operation available for Maps.
Value *[]OperationsValueItem `json:"value,omitempty"`
}
func (o Operations) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Operations.
OperationsValueItem ...
type OperationsValueItem struct {
// Name - READ-ONLY; Operation name: {provider}/{resource}/{operation}.
Name *string `json:"name,omitempty"`
// Display - The human-readable description of the operation.
Display *OperationsValueItemDisplay `json:"display,omitempty"`
// Origin - READ-ONLY; The origin of the operation.
Origin *string `json:"origin,omitempty"`
}
func (oI OperationsValueItem) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationsValueItem.
OperationsValueItemDisplay the human-readable description of the operation.
type OperationsValueItemDisplay struct {
// Provider - READ-ONLY; Service provider: Microsoft Maps.
Provider *string `json:"provider,omitempty"`
// Resource - READ-ONLY; Resource on which the operation is performed.
Resource *string `json:"resource,omitempty"`
// Operation - READ-ONLY; The action that users can perform, based on their permission level.
Operation *string `json:"operation,omitempty"`
// Description - READ-ONLY; The description of the operation.
Description *string `json:"description,omitempty"`
}
func (oI OperationsValueItemDisplay) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationsValueItemDisplay.
Resource an Azure resource
type Resource struct {
// ID - READ-ONLY; The fully qualified Maps Account resource identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the Maps Account, which is unique within a Resource Group.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Azure resource type.
Type *string `json:"type,omitempty"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
Sku the SKU of the Maps Account.
type Sku struct {
// Name - The name of the SKU, in standard format (such as S0).
Name *string `json:"name,omitempty"`
// Tier - READ-ONLY; Gets the sku tier. This is based on the SKU name.
Tier *string `json:"tier,omitempty"`
}
func (s Sku) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Sku.