azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/preview/maps/mgmt/2020-02-01-preview/maps Index | Files | Directories

package maps

import "github.com/Azure/azure-sdk-for-go/services/preview/maps/mgmt/2020-02-01-preview/maps"

Package maps implements the Azure ARM Maps service API version 2020-02-01-preview.

Resource Provider

Index

Package Files

accounts.go client.go creators.go enums.go maps.go models.go privateatlases.go version.go

Constants

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

func UserAgent Uses

❖
func UserAgent() string

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

func Version Uses

❖
func Version() string

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

type Account Uses

❖
type Account struct {
    autorest.Response `json:"-"`
    // Sku - READ-ONLY; The SKU of this account.
    Sku *Sku `json:"sku,omitempty"`
    // SystemData - READ-ONLY; The system meta data relating to this resource.
    SystemData *SystemData `json:"systemData,omitempty"`
    // Properties - READ-ONLY; The map account properties.
    Properties *AccountProperties `json:"properties,omitempty"`
    // Tags - Resource tags.
    Tags map[string]*string `json:"tags"`
    // Location - The geo-location where the resource lives
    Location *string `json:"location,omitempty"`
    // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

Account an Azure resource which represents access to a suite of Maps REST APIs.

func (Account) MarshalJSON Uses

❖
func (a Account) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Account.

type AccountCreateParameters Uses

❖
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). 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"`
}

AccountCreateParameters parameters used to create a new Maps Account.

func (AccountCreateParameters) MarshalJSON Uses

❖
func (acp AccountCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountCreateParameters.

type AccountKeys Uses

❖
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"`
}

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 AccountProperties Uses

❖
type AccountProperties struct {
    // XMsClientID - A unique identifier for the maps account
    XMsClientID *string `json:"x-ms-client-id,omitempty"`
}

AccountProperties additional Map account properties

type AccountUpdateParameters Uses

❖
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"`
}

AccountUpdateParameters parameters used to update an existing Maps Account.

func (AccountUpdateParameters) MarshalJSON Uses

❖
func (aup AccountUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountUpdateParameters.

type Accounts Uses

❖
type Accounts struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; a Maps Account.
    Value *[]Account `json:"value,omitempty"`
}

Accounts a list of Maps Accounts.

type AccountsClient Uses

❖
type AccountsClient struct {
    BaseClient
}

AccountsClient is the resource Provider

func NewAccountsClient Uses

❖
func NewAccountsClient(subscriptionID string) AccountsClient

NewAccountsClient creates an instance of the AccountsClient client.

func NewAccountsClientWithBaseURI Uses

❖
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 (AccountsClient) CreateOrUpdate Uses

❖
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 resource group. The name is case insensitive. accountName - the name of the Maps Account. mapsAccountCreateParameters - the new or updated parameters for the Maps Account.

func (AccountsClient) CreateOrUpdatePreparer Uses

❖
func (client AccountsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, mapsAccountCreateParameters AccountCreateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AccountsClient) CreateOrUpdateResponder Uses

❖
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 (AccountsClient) CreateOrUpdateSender Uses

❖
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 Uses

❖
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 resource group. The name is case insensitive. accountName - the name of the Maps Account.

func (AccountsClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (AccountsClient) DeleteResponder Uses

❖
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 Uses

❖
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 Uses

❖
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 resource group. The name is case insensitive. accountName - the name of the Maps Account.

func (AccountsClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (AccountsClient) GetResponder Uses

❖
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 (AccountsClient) GetSender Uses

❖
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 Uses

❖
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 resource group. The name is case insensitive.

func (AccountsClient) ListByResourceGroupPreparer Uses

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (AccountsClient) ListByResourceGroupResponder Uses

❖
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 (AccountsClient) ListByResourceGroupSender Uses

❖
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 Uses

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

ListBySubscription get all Maps Accounts in a Subscription

func (AccountsClient) ListBySubscriptionPreparer Uses

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

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (AccountsClient) ListBySubscriptionResponder Uses

❖
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 (AccountsClient) ListBySubscriptionSender Uses

❖
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 Uses

❖
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 resource group. The name is case insensitive. accountName - the name of the Maps Account.

func (AccountsClient) ListKeysPreparer Uses

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

ListKeysPreparer prepares the ListKeys request.

func (AccountsClient) ListKeysResponder Uses

❖
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 (AccountsClient) ListKeysSender Uses

❖
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) RegenerateKeys Uses

❖
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 resource group. The name is case insensitive. accountName - the name of the Maps Account. keySpecification - which key to regenerate: primary or secondary.

func (AccountsClient) RegenerateKeysPreparer Uses

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

RegenerateKeysPreparer prepares the RegenerateKeys request.

func (AccountsClient) RegenerateKeysResponder Uses

❖
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 (AccountsClient) RegenerateKeysSender Uses

❖
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 Uses

❖
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 resource group. The name is case insensitive. accountName - the name of the Maps Account. mapsAccountUpdateParameters - the updated parameters for the Maps Account.

func (AccountsClient) UpdatePreparer Uses

❖
func (client AccountsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, mapsAccountUpdateParameters AccountUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (AccountsClient) UpdateResponder Uses

❖
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 (AccountsClient) UpdateSender Uses

❖
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 AzureEntityResource Uses

❖
type AzureEntityResource struct {
    // Etag - READ-ONLY; Resource Etag.
    Etag *string `json:"etag,omitempty"`
    // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.

type BaseClient Uses

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

BaseClient is the base client for Maps.

func New Uses

❖
func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

❖
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).

type Client Uses

❖
type Client struct {
    BaseClient
}

Client is the resource Provider

func NewClient Uses

❖
func NewClient(subscriptionID string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI Uses

❖
func NewClientWithBaseURI(baseURI string, subscriptionID string) Client

NewClientWithBaseURI creates an instance of the Client 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) ListOperations Uses

❖
func (client Client) ListOperations(ctx context.Context) (result Operations, err error)

ListOperations list operations available for the Maps Resource Provider

func (Client) ListOperationsPreparer Uses

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

ListOperationsPreparer prepares the ListOperations request.

func (Client) ListOperationsResponder Uses

❖
func (client Client) 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) ListOperationsSender Uses

❖
func (client Client) 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.

type CreatedByType Uses

❖
type CreatedByType string

CreatedByType enumerates the values for created by type.

❖
const (
    // Application ...
    Application CreatedByType = "Application"
    // Key ...
    Key CreatedByType = "Key"
    // ManagedIdentity ...
    ManagedIdentity CreatedByType = "ManagedIdentity"
    // User ...
    User CreatedByType = "User"
)

func PossibleCreatedByTypeValues Uses

❖
func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.

type Creator Uses

❖
type Creator struct {
    autorest.Response `json:"-"`
    // Properties - The Creator resource properties.
    Properties *CreatorProperties `json:"properties,omitempty"`
    // Tags - Resource tags.
    Tags map[string]*string `json:"tags"`
    // Location - The geo-location where the resource lives
    Location *string `json:"location,omitempty"`
    // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

Creator an Azure resource which represents Maps Creator product and provides ability to manage private location data.

func (Creator) MarshalJSON Uses

❖
func (c Creator) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Creator.

type CreatorCreateParameters Uses

❖
type CreatorCreateParameters 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"`
}

CreatorCreateParameters parameters used to create a new Maps Creator resource.

func (CreatorCreateParameters) MarshalJSON Uses

❖
func (ccp CreatorCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreatorCreateParameters.

type CreatorList Uses

❖
type CreatorList struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; a Creator account.
    Value *[]Creator `json:"value,omitempty"`
}

CreatorList a list of Creator resources.

type CreatorProperties Uses

❖
type CreatorProperties struct {
    // ProvisioningState - The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled
    ProvisioningState *string `json:"provisioningState,omitempty"`
}

CreatorProperties creator resource properties

type CreatorUpdateParameters Uses

❖
type CreatorUpdateParameters 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"`
}

CreatorUpdateParameters parameters used to update an existing Creator resource.

func (CreatorUpdateParameters) MarshalJSON Uses

❖
func (cup CreatorUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreatorUpdateParameters.

type CreatorsClient Uses

❖
type CreatorsClient struct {
    BaseClient
}

CreatorsClient is the resource Provider

func NewCreatorsClient Uses

❖
func NewCreatorsClient(subscriptionID string) CreatorsClient

NewCreatorsClient creates an instance of the CreatorsClient client.

func NewCreatorsClientWithBaseURI Uses

❖
func NewCreatorsClientWithBaseURI(baseURI string, subscriptionID string) CreatorsClient

NewCreatorsClientWithBaseURI creates an instance of the CreatorsClient 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 (CreatorsClient) CreateOrUpdate Uses

❖
func (client CreatorsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, creatorName string, creatorCreateParameters CreatorCreateParameters) (result Creator, err error)

CreateOrUpdate create or update a Maps Creator resource. Creator resource will manage Azure resources required to populate a custom set of mapping data. It requires an account to exist before it can be created. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the name of the Maps Account. creatorName - the name of the Maps Creator instance. creatorCreateParameters - the new or updated parameters for the Creator resource.

func (CreatorsClient) CreateOrUpdatePreparer Uses

❖
func (client CreatorsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, creatorName string, creatorCreateParameters CreatorCreateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (CreatorsClient) CreateOrUpdateResponder Uses

❖
func (client CreatorsClient) CreateOrUpdateResponder(resp *http.Response) (result Creator, err error)

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

func (CreatorsClient) CreateOrUpdateSender Uses

❖
func (client CreatorsClient) 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 (CreatorsClient) Delete Uses

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

Delete delete a Maps Creator resource. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the name of the Maps Account. creatorName - the name of the Maps Creator instance.

func (CreatorsClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (CreatorsClient) DeleteResponder Uses

❖
func (client CreatorsClient) 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 (CreatorsClient) DeleteSender Uses

❖
func (client CreatorsClient) 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 (CreatorsClient) Get Uses

❖
func (client CreatorsClient) Get(ctx context.Context, resourceGroupName string, accountName string, creatorName string) (result Creator, err error)

Get get a Maps Creator resource. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the name of the Maps Account. creatorName - the name of the Maps Creator instance.

func (CreatorsClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (CreatorsClient) GetResponder Uses

❖
func (client CreatorsClient) GetResponder(resp *http.Response) (result Creator, err error)

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

func (CreatorsClient) GetSender Uses

❖
func (client CreatorsClient) 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 (CreatorsClient) ListByAccount Uses

❖
func (client CreatorsClient) ListByAccount(ctx context.Context, resourceGroupName string, accountName string) (result CreatorList, err error)

ListByAccount get all Creator instances for an Azure Maps Account Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the name of the Maps Account.

func (CreatorsClient) ListByAccountPreparer Uses

❖
func (client CreatorsClient) ListByAccountPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

ListByAccountPreparer prepares the ListByAccount request.

func (CreatorsClient) ListByAccountResponder Uses

❖
func (client CreatorsClient) ListByAccountResponder(resp *http.Response) (result CreatorList, err error)

ListByAccountResponder handles the response to the ListByAccount request. The method always closes the http.Response Body.

func (CreatorsClient) ListByAccountSender Uses

❖
func (client CreatorsClient) ListByAccountSender(req *http.Request) (*http.Response, error)

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

func (CreatorsClient) Update Uses

❖
func (client CreatorsClient) Update(ctx context.Context, resourceGroupName string, accountName string, creatorName string, creatorUpdateParameters CreatorUpdateParameters) (result Creator, err error)

Update updates the Maps Creator resource. Only a subset of the parameters may be updated after creation, such as Tags. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the name of the Maps Account. creatorName - the name of the Maps Creator instance. creatorUpdateParameters - the update parameters for Maps Creator.

func (CreatorsClient) UpdatePreparer Uses

❖
func (client CreatorsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, creatorName string, creatorUpdateParameters CreatorUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (CreatorsClient) UpdateResponder Uses

❖
func (client CreatorsClient) UpdateResponder(resp *http.Response) (result Creator, err error)

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

func (CreatorsClient) UpdateSender Uses

❖
func (client CreatorsClient) 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 ErrorAdditionalInfo Uses

❖
type ErrorAdditionalInfo struct {
    // Type - READ-ONLY; The additional info type.
    Type *string `json:"type,omitempty"`
    // Info - READ-ONLY; The additional info.
    Info interface{} `json:"info,omitempty"`
}

ErrorAdditionalInfo the resource management error additional info.

type ErrorDetail Uses

❖
type ErrorDetail struct {
    // Code - READ-ONLY; The error code.
    Code *string `json:"code,omitempty"`
    // Message - READ-ONLY; The error message.
    Message *string `json:"message,omitempty"`
    // Target - READ-ONLY; The error target.
    Target *string `json:"target,omitempty"`
    // Details - READ-ONLY; The error details.
    Details *[]ErrorDetail `json:"details,omitempty"`
    // AdditionalInfo - READ-ONLY; The error additional info.
    AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}

ErrorDetail the error detail.

type ErrorResponse Uses

❖
type ErrorResponse struct {
    // Error - The error object.
    Error *ErrorDetail `json:"error,omitempty"`
}

ErrorResponse common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

type KeySpecification Uses

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

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

type KeyType Uses

❖
type KeyType string

KeyType enumerates the values for key type.

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

func PossibleKeyTypeValues Uses

❖
func PossibleKeyTypeValues() []KeyType

PossibleKeyTypeValues returns an array of possible values for the KeyType const type.

type Operations Uses

❖
type Operations struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; An operation available for Maps.
    Value *[]OperationsValueItem `json:"value,omitempty"`
}

Operations the set of operations available for Maps.

type OperationsValueItem Uses

❖
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"`
}

OperationsValueItem ...

func (OperationsValueItem) MarshalJSON Uses

❖
func (oI OperationsValueItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationsValueItem.

type OperationsValueItemDisplay Uses

❖
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"`
}

OperationsValueItemDisplay the human-readable description of the operation.

type PrivateAtlas Uses

❖
type PrivateAtlas struct {
    autorest.Response `json:"-"`
    // Properties - The Private Atlas resource properties.
    Properties *PrivateAtlasProperties `json:"properties,omitempty"`
    // Tags - Resource tags.
    Tags map[string]*string `json:"tags"`
    // Location - The geo-location where the resource lives
    Location *string `json:"location,omitempty"`
    // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

PrivateAtlas an Azure resource which represents which will provision the ability to create private location data.

func (PrivateAtlas) MarshalJSON Uses

❖
func (pa PrivateAtlas) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateAtlas.

type PrivateAtlasCreateParameters Uses

❖
type PrivateAtlasCreateParameters 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"`
}

PrivateAtlasCreateParameters parameters used to create a new Private Atlas resource.

func (PrivateAtlasCreateParameters) MarshalJSON Uses

❖
func (pacp PrivateAtlasCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateAtlasCreateParameters.

type PrivateAtlasList Uses

❖
type PrivateAtlasList struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; a Private Atlas.
    Value *[]PrivateAtlas `json:"value,omitempty"`
}

PrivateAtlasList a list of Private Atlas resources.

type PrivateAtlasProperties Uses

❖
type PrivateAtlasProperties struct {
    // ProvisioningState - The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled
    ProvisioningState *string `json:"provisioningState,omitempty"`
}

PrivateAtlasProperties private Atlas resource properties

type PrivateAtlasUpdateParameters Uses

❖
type PrivateAtlasUpdateParameters 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"`
}

PrivateAtlasUpdateParameters parameters used to update an existing Private Atlas resource.

func (PrivateAtlasUpdateParameters) MarshalJSON Uses

❖
func (paup PrivateAtlasUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateAtlasUpdateParameters.

type PrivateAtlasesClient Uses

❖
type PrivateAtlasesClient struct {
    BaseClient
}

PrivateAtlasesClient is the resource Provider

func NewPrivateAtlasesClient Uses

❖
func NewPrivateAtlasesClient(subscriptionID string) PrivateAtlasesClient

NewPrivateAtlasesClient creates an instance of the PrivateAtlasesClient client.

func NewPrivateAtlasesClientWithBaseURI Uses

❖
func NewPrivateAtlasesClientWithBaseURI(baseURI string, subscriptionID string) PrivateAtlasesClient

NewPrivateAtlasesClientWithBaseURI creates an instance of the PrivateAtlasesClient 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 (PrivateAtlasesClient) CreateOrUpdate Uses

❖
func (client PrivateAtlasesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, privateAtlasName string, privateAtlasCreateParameters PrivateAtlasCreateParameters) (result PrivateAtlas, err error)

CreateOrUpdate create or update a Private Atlas resource. Private Atlas resource will enable the usage of Azure resources to build a custom set of mapping data. It requires an account to exist before it can be created. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the name of the Maps Account. privateAtlasName - the name of the Private Atlas instance. privateAtlasCreateParameters - the new or updated parameters for the Private Atlas resource.

func (PrivateAtlasesClient) CreateOrUpdatePreparer Uses

❖
func (client PrivateAtlasesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, privateAtlasName string, privateAtlasCreateParameters PrivateAtlasCreateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PrivateAtlasesClient) CreateOrUpdateResponder Uses

❖
func (client PrivateAtlasesClient) CreateOrUpdateResponder(resp *http.Response) (result PrivateAtlas, err error)

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

func (PrivateAtlasesClient) CreateOrUpdateSender Uses

❖
func (client PrivateAtlasesClient) 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 (PrivateAtlasesClient) Delete Uses

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

Delete delete a Private Atlas resource. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the name of the Maps Account. privateAtlasName - the name of the Private Atlas instance.

func (PrivateAtlasesClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (PrivateAtlasesClient) DeleteResponder Uses

❖
func (client PrivateAtlasesClient) 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 (PrivateAtlasesClient) DeleteSender Uses

❖
func (client PrivateAtlasesClient) 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 (PrivateAtlasesClient) Get Uses

❖
func (client PrivateAtlasesClient) Get(ctx context.Context, resourceGroupName string, accountName string, privateAtlasName string) (result PrivateAtlas, err error)

Get get a Private Atlas resource. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the name of the Maps Account. privateAtlasName - the name of the Private Atlas instance.

func (PrivateAtlasesClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (PrivateAtlasesClient) GetResponder Uses

❖
func (client PrivateAtlasesClient) GetResponder(resp *http.Response) (result PrivateAtlas, err error)

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

func (PrivateAtlasesClient) GetSender Uses

❖
func (client PrivateAtlasesClient) 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 (PrivateAtlasesClient) ListByAccount Uses

❖
func (client PrivateAtlasesClient) ListByAccount(ctx context.Context, resourceGroupName string, accountName string) (result PrivateAtlasList, err error)

ListByAccount get all Private Atlas instances for an Azure Map Account Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the name of the Maps Account.

func (PrivateAtlasesClient) ListByAccountPreparer Uses

❖
func (client PrivateAtlasesClient) ListByAccountPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

ListByAccountPreparer prepares the ListByAccount request.

func (PrivateAtlasesClient) ListByAccountResponder Uses

❖
func (client PrivateAtlasesClient) ListByAccountResponder(resp *http.Response) (result PrivateAtlasList, err error)

ListByAccountResponder handles the response to the ListByAccount request. The method always closes the http.Response Body.

func (PrivateAtlasesClient) ListByAccountSender Uses

❖
func (client PrivateAtlasesClient) ListByAccountSender(req *http.Request) (*http.Response, error)

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

func (PrivateAtlasesClient) Update Uses

❖
func (client PrivateAtlasesClient) Update(ctx context.Context, resourceGroupName string, accountName string, privateAtlasName string, privateAtlasUpdateParameters PrivateAtlasUpdateParameters) (result PrivateAtlas, err error)

Update updates the Private Atlas resource. Only a subset of the parameters may be updated after creation, such as Tags. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the name of the Maps Account. privateAtlasName - the name of the Private Atlas instance. privateAtlasUpdateParameters - the updated parameters for the Private Atlas.

func (PrivateAtlasesClient) UpdatePreparer Uses

❖
func (client PrivateAtlasesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, privateAtlasName string, privateAtlasUpdateParameters PrivateAtlasUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (PrivateAtlasesClient) UpdateResponder Uses

❖
func (client PrivateAtlasesClient) UpdateResponder(resp *http.Response) (result PrivateAtlas, err error)

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

func (PrivateAtlasesClient) UpdateSender Uses

❖
func (client PrivateAtlasesClient) 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 ProxyResource Uses

❖
type ProxyResource struct {
    // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for an Azure Resource Manager proxy resource. It will have everything other than required location and tags

type Resource Uses

❖
type Resource struct {
    // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

Resource common fields that are returned in the response for all Azure Resource Manager resources

type Sku Uses

❖
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"`
}

Sku the SKU of the Maps Account.

func (Sku) MarshalJSON Uses

❖
func (s Sku) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Sku.

type SystemData Uses

❖
type SystemData struct {
    // CreatedBy - The identity that created the resource.
    CreatedBy *string `json:"createdBy,omitempty"`
    // CreatedByType - The type of identity that created the resource. Possible values include: 'User', 'Application', 'ManagedIdentity', 'Key'
    CreatedByType CreatedByType `json:"createdByType,omitempty"`
    // CreatedAt - The timestamp of resource creation (UTC).
    CreatedAt *date.Time `json:"createdAt,omitempty"`
    // LastModifiedBy - The identity that last modified the resource.
    LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
    // LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'User', 'Application', 'ManagedIdentity', 'Key'
    LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"`
    // LastModifiedAt - The type of identity that last modified the resource.
    LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}

SystemData metadata pertaining to creation and last modification of the resource.

type TrackedResource Uses

❖
type TrackedResource struct {
    // Tags - Resource tags.
    Tags map[string]*string `json:"tags"`
    // Location - The geo-location where the resource lives
    Location *string `json:"location,omitempty"`
    // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource

func (TrackedResource) MarshalJSON Uses

❖
func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

Directories

PathSynopsis
mapsapi

Package maps imports 9 packages (graph) and is imported by 1 packages. Updated 2021-01-19. Refresh now. Tools for package owners.