maps

package
v61.2.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jan 14, 2022 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

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

Azure Maps

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Maps
	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 Account 

type Account struct {
	autorest.Response `json:"-"`
	// Sku - The SKU of this account.
	Sku *Sku `json:"sku,omitempty"`
	// Kind - Get or Set Kind property. Possible values include: 'KindGen1', 'KindGen2'
	Kind Kind `json:"kind,omitempty"`
	// SystemData - READ-ONLY; The system meta data relating to this resource.
	SystemData *SystemData `json:"systemData,omitempty"`
	// Properties - 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 

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

MarshalJSON is the custom marshaler for Account.

type AccountKeys 

type AccountKeys struct {
	autorest.Response `json:"-"`
	// PrimaryKeyLastUpdated - READ-ONLY; The last updated date and time of the primary key.
	PrimaryKeyLastUpdated *string `json:"primaryKeyLastUpdated,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"`
	// SecondaryKeyLastUpdated - READ-ONLY; The last updated date and time of the secondary key.
	SecondaryKeyLastUpdated *string `json:"secondaryKeyLastUpdated,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.

func (AccountKeys) MarshalJSON 

func (ak AccountKeys) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountKeys.

type AccountProperties 

type AccountProperties struct {
	// UniqueID - READ-ONLY; A unique identifier for the maps account
	UniqueID *string `json:"uniqueId,omitempty"`
	// DisableLocalAuth - Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys authentication from any usage.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`
	// ProvisioningState - READ-ONLY; the state of the provisioning.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

AccountProperties additional Map account properties

func (AccountProperties) MarshalJSON 

func (ap AccountProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountProperties.

type AccountUpdateParameters 

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"`
	// Kind - Get or Set Kind property. Possible values include: 'KindGen1', 'KindGen2'
	Kind Kind `json:"kind,omitempty"`
	// Sku - The SKU of this account.
	Sku *Sku `json:"sku,omitempty"`
	// AccountProperties - The map account properties.
	*AccountProperties `json:"properties,omitempty"`
}

AccountUpdateParameters parameters used to update an existing Maps Account.

func (AccountUpdateParameters) MarshalJSON 

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

MarshalJSON is the custom marshaler for AccountUpdateParameters.

func (*AccountUpdateParameters) UnmarshalJSON 

func (aup *AccountUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AccountUpdateParameters struct.

type Accounts 

type Accounts struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; a Maps Account.
	Value *[]Account `json:"value,omitempty"`
	// NextLink - URL client should use to fetch the next page (per server side paging).
	// It's null for now, added for future use.
	NextLink *string `json:"nextLink,omitempty"`
}

Accounts a list of Maps Accounts.

func (Accounts) IsEmpty 

func (a Accounts) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (Accounts) MarshalJSON 

func (a Accounts) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Accounts.

type AccountsClient 

type AccountsClient struct {
	BaseClient
}

AccountsClient is the azure Maps

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

func (client AccountsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, mapsAccount Account) (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. mapsAccount - the new or updated parameters for the Maps Account.

func (AccountsClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AccountsClient) CreateOrUpdateResponder 

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 

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

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

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 Account, 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 AccountsPage, 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) ListByResourceGroupComplete 

func (client AccountsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result AccountsIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

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 Accounts, 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 AccountsPage, err error)

ListBySubscription get all Maps Accounts in a Subscription

func (AccountsClient) ListBySubscriptionComplete 

func (client AccountsClient) ListBySubscriptionComplete(ctx context.Context) (result AccountsIterator, err error)

ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

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 Accounts, 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 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 

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 AccountKeys, 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) RegenerateKeys 

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 

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

RegenerateKeysPreparer prepares the RegenerateKeys request.

func (AccountsClient) RegenerateKeysResponder 

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 

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, 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, Tags, Properties. 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 

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

UpdatePreparer prepares the Update request.

func (AccountsClient) UpdateResponder 

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 

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 AccountsIterator 

type AccountsIterator struct {
	// contains filtered or unexported fields
}

AccountsIterator provides access to a complete listing of Account values.

func NewAccountsIterator 

func NewAccountsIterator(page AccountsPage) AccountsIterator

Creates a new instance of the AccountsIterator type.

func (*AccountsIterator) Next 

func (iter *AccountsIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AccountsIterator) NextWithContext 

func (iter *AccountsIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (AccountsIterator) NotDone 

func (iter AccountsIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (AccountsIterator) Response 

func (iter AccountsIterator) Response() Accounts

Response returns the raw server response from the last page request.

func (AccountsIterator) Value 

func (iter AccountsIterator) Value() Account

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type AccountsPage 

type AccountsPage struct {
	// contains filtered or unexported fields
}

AccountsPage contains a page of Account values.

func NewAccountsPage 

func NewAccountsPage(cur Accounts, getNextPage func(context.Context, Accounts) (Accounts, error)) AccountsPage

Creates a new instance of the AccountsPage type.

func (*AccountsPage) Next 

func (page *AccountsPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AccountsPage) NextWithContext 

func (page *AccountsPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (AccountsPage) NotDone 

func (page AccountsPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (AccountsPage) Response 

func (page AccountsPage) Response() Accounts

Response returns the raw server response from the last page request.

func (AccountsPage) Values 

func (page AccountsPage) Values() []Account

Values returns the slice of values for the current page or nil if there are no values.

type AzureEntityResource 

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.

func (AzureEntityResource) MarshalJSON 

func (aer AzureEntityResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureEntityResource.

type BaseClient 

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

BaseClient is the base client for Maps.

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

type Client struct {
	BaseClient
}

Client is the azure Maps

func NewClient 

func NewClient(subscriptionID string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI 

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 

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

ListOperations list operations available for the Maps Resource Provider

func (Client) ListOperationsComplete 

func (client Client) ListOperationsComplete(ctx context.Context) (result OperationsIterator, err error)

ListOperationsComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListOperationsPreparer 

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

ListOperationsPreparer prepares the ListOperations request.

func (Client) ListOperationsResponder 

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 

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 

type CreatedByType string

CreatedByType enumerates the values for created by type. 

const (
	// CreatedByTypeApplication ...
	CreatedByTypeApplication CreatedByType = "Application"
	// CreatedByTypeKey ...
	CreatedByTypeKey CreatedByType = "Key"
	// CreatedByTypeManagedIdentity ...
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	// CreatedByTypeUser ...
	CreatedByTypeUser CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

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

type Creator 

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 

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

MarshalJSON is the custom marshaler for Creator.

type CreatorList 

type CreatorList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; a Creator account.
	Value *[]Creator `json:"value,omitempty"`
	// NextLink - URL client should use to fetch the next page (per server side paging).
	// It's null for now, added for future use.
	NextLink *string `json:"nextLink,omitempty"`
}

CreatorList a list of Creator resources.

func (CreatorList) IsEmpty 

func (cl CreatorList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (CreatorList) MarshalJSON 

func (cl CreatorList) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreatorList.

type CreatorListIterator 

type CreatorListIterator struct {
	// contains filtered or unexported fields
}

CreatorListIterator provides access to a complete listing of Creator values.

func NewCreatorListIterator 

func NewCreatorListIterator(page CreatorListPage) CreatorListIterator

Creates a new instance of the CreatorListIterator type.

func (*CreatorListIterator) Next 

func (iter *CreatorListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*CreatorListIterator) NextWithContext 

func (iter *CreatorListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (CreatorListIterator) NotDone 

func (iter CreatorListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (CreatorListIterator) Response 

func (iter CreatorListIterator) Response() CreatorList

Response returns the raw server response from the last page request.

func (CreatorListIterator) Value 

func (iter CreatorListIterator) Value() Creator

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type CreatorListPage 

type CreatorListPage struct {
	// contains filtered or unexported fields
}

CreatorListPage contains a page of Creator values.

func NewCreatorListPage 

func NewCreatorListPage(cur CreatorList, getNextPage func(context.Context, CreatorList) (CreatorList, error)) CreatorListPage

Creates a new instance of the CreatorListPage type.

func (*CreatorListPage) Next 

func (page *CreatorListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*CreatorListPage) NextWithContext 

func (page *CreatorListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (CreatorListPage) NotDone 

func (page CreatorListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (CreatorListPage) Response 

func (page CreatorListPage) Response() CreatorList

Response returns the raw server response from the last page request.

func (CreatorListPage) Values 

func (page CreatorListPage) Values() []Creator

Values returns the slice of values for the current page or nil if there are no values.

type CreatorProperties 

type CreatorProperties struct {
	// ProvisioningState - READ-ONLY; The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// StorageUnits - The storage units to be allocated. Integer values from 1 to 100, inclusive.
	StorageUnits *int32 `json:"storageUnits,omitempty"`
}

CreatorProperties creator resource properties

func (CreatorProperties) MarshalJSON 

func (cp CreatorProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreatorProperties.

type CreatorUpdateParameters 

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"`
	// CreatorProperties - Creator resource properties.
	*CreatorProperties `json:"properties,omitempty"`
}

CreatorUpdateParameters parameters used to update an existing Creator resource.

func (CreatorUpdateParameters) MarshalJSON 

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

MarshalJSON is the custom marshaler for CreatorUpdateParameters.

func (*CreatorUpdateParameters) UnmarshalJSON 

func (cup *CreatorUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CreatorUpdateParameters struct.

type CreatorsClient 

type CreatorsClient struct {
	BaseClient
}

CreatorsClient is the azure Maps

func NewCreatorsClient 

func NewCreatorsClient(subscriptionID string) CreatorsClient

NewCreatorsClient creates an instance of the CreatorsClient client.

func NewCreatorsClientWithBaseURI 

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 

func (client CreatorsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, creatorName string, creatorResource Creator) (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. creatorResource - the new or updated parameters for the Creator resource.

func (CreatorsClient) CreateOrUpdatePreparer 

func (client CreatorsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, creatorName string, creatorResource Creator) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (CreatorsClient) CreateOrUpdateResponder 

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 

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 

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 

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

DeletePreparer prepares the Delete request.

func (CreatorsClient) DeleteResponder 

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 

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 

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 

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

GetPreparer prepares the Get request.

func (CreatorsClient) GetResponder 

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 

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 

func (client CreatorsClient) ListByAccount(ctx context.Context, resourceGroupName string, accountName string) (result CreatorListPage, 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) ListByAccountComplete 

func (client CreatorsClient) ListByAccountComplete(ctx context.Context, resourceGroupName string, accountName string) (result CreatorListIterator, err error)

ListByAccountComplete enumerates all values, automatically crossing page boundaries as required.

func (CreatorsClient) ListByAccountPreparer 

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

ListByAccountPreparer prepares the ListByAccount request.

func (CreatorsClient) ListByAccountResponder 

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 

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 

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 

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 

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 

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 Dimension 

type Dimension struct {
	// Name - Display name of dimension.
	Name *string `json:"name,omitempty"`
	// DisplayName - Display name of dimension.
	DisplayName *string `json:"displayName,omitempty"`
}

Dimension dimension of map account, for example API Category, Api Name, Result Type, and Response Code.

type ErrorAdditionalInfo 

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.

func (ErrorAdditionalInfo) MarshalJSON 

func (eai ErrorAdditionalInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorAdditionalInfo.

type ErrorDetail 

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.

func (ErrorDetail) MarshalJSON 

func (ed ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorDetail.

type ErrorResponse 

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 

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

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

type KeyType 

type KeyType string

KeyType enumerates the values for key type. 

const (
	// KeyTypePrimary ...
	KeyTypePrimary KeyType = "primary"
	// KeyTypeSecondary ...
	KeyTypeSecondary KeyType = "secondary"
)

func PossibleKeyTypeValues 

func PossibleKeyTypeValues() []KeyType

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

type Kind 

type Kind string

Kind enumerates the values for kind. 

const (
	// KindGen1 ...
	KindGen1 Kind = "Gen1"
	// KindGen2 ...
	KindGen2 Kind = "Gen2"
)

func PossibleKindValues 

func PossibleKindValues() []Kind

PossibleKindValues returns an array of possible values for the Kind const type.

type MetricSpecification 

type MetricSpecification struct {
	// Name - Name of metric specification.
	Name *string `json:"name,omitempty"`
	// DisplayName - Display name of metric specification.
	DisplayName *string `json:"displayName,omitempty"`
	// DisplayDescription - Display description of metric specification.
	DisplayDescription *string `json:"displayDescription,omitempty"`
	// Unit - Unit could be Count.
	Unit *string `json:"unit,omitempty"`
	// Dimensions - Dimensions of map account.
	Dimensions *[]Dimension `json:"dimensions,omitempty"`
	// AggregationType - Aggregation type could be Average.
	AggregationType *string `json:"aggregationType,omitempty"`
	// FillGapWithZero - The property to decide fill gap with zero or not.
	FillGapWithZero *bool `json:"fillGapWithZero,omitempty"`
	// Category - The category this metric specification belong to, could be Capacity.
	Category *string `json:"category,omitempty"`
	// ResourceIDDimensionNameOverride - Account Resource Id.
	ResourceIDDimensionNameOverride *string `json:"resourceIdDimensionNameOverride,omitempty"`
}

MetricSpecification metric specification of operation.

type Name 

type Name string

Name enumerates the values for name. 

const (
	// NameG2 ...
	NameG2 Name = "G2"
	// NameS0 ...
	NameS0 Name = "S0"
	// NameS1 ...
	NameS1 Name = "S1"
)

func PossibleNameValues 

func PossibleNameValues() []Name

PossibleNameValues returns an array of possible values for the Name const type.

type OperationDetail 

type OperationDetail struct {
	// Name - Name of the operation
	Name *string `json:"name,omitempty"`
	// IsDataAction - Indicates whether the operation is a data action
	IsDataAction *bool `json:"isDataAction,omitempty"`
	// Display - Display of the operation
	Display *OperationDisplay `json:"display,omitempty"`
	// Origin - Origin of the operation
	Origin *string `json:"origin,omitempty"`
	// OperationProperties - Properties of the operation
	*OperationProperties `json:"properties,omitempty"`
}

OperationDetail operation detail payload

func (OperationDetail) MarshalJSON 

func (od OperationDetail) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationDetail.

func (*OperationDetail) UnmarshalJSON 

func (od *OperationDetail) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for OperationDetail struct.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Resource provider of the operation
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource of the operation
	Resource *string `json:"resource,omitempty"`
	// Operation - Localized friendly name for the operation
	Operation *string `json:"operation,omitempty"`
	// Description - Localized friendly description for the operation
	Description *string `json:"description,omitempty"`
}

OperationDisplay operation display payload

type OperationProperties 

type OperationProperties struct {
	// ServiceSpecification - One property of operation, include metric specifications.
	ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationProperties properties of operation, include metric specifications.

type Operations 

type Operations struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; An operation available for Maps.
	Value *[]OperationDetail `json:"value,omitempty"`
	// NextLink - URL client should use to fetch the next page (per server side paging).
	// It's null for now, added for future use.
	NextLink *string `json:"nextLink,omitempty"`
}

Operations the set of operations available for Maps.

func (Operations) IsEmpty 

func (o Operations) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (Operations) MarshalJSON 

func (o Operations) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Operations.

type OperationsIterator 

type OperationsIterator struct {
	// contains filtered or unexported fields
}

OperationsIterator provides access to a complete listing of OperationDetail values.

func NewOperationsIterator 

func NewOperationsIterator(page OperationsPage) OperationsIterator

Creates a new instance of the OperationsIterator type.

func (*OperationsIterator) Next 

func (iter *OperationsIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationsIterator) NextWithContext 

func (iter *OperationsIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationsIterator) NotDone 

func (iter OperationsIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationsIterator) Response 

func (iter OperationsIterator) Response() Operations

Response returns the raw server response from the last page request.

func (OperationsIterator) Value 

func (iter OperationsIterator) Value() OperationDetail

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationsPage 

type OperationsPage struct {
	// contains filtered or unexported fields
}

OperationsPage contains a page of OperationDetail values.

func NewOperationsPage 

func NewOperationsPage(cur Operations, getNextPage func(context.Context, Operations) (Operations, error)) OperationsPage

Creates a new instance of the OperationsPage type.

func (*OperationsPage) Next 

func (page *OperationsPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationsPage) NextWithContext 

func (page *OperationsPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationsPage) NotDone 

func (page OperationsPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationsPage) Response 

func (page OperationsPage) Response() Operations

Response returns the raw server response from the last page request.

func (OperationsPage) Values 

func (page OperationsPage) Values() []OperationDetail

Values returns the slice of values for the current page or nil if there are no values.

type ProxyResource 

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 a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON 

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type Resource 

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

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type ServiceSpecification 

type ServiceSpecification struct {
	// MetricSpecifications - Metric specifications of operation.
	MetricSpecifications *[]MetricSpecification `json:"metricSpecifications,omitempty"`
}

ServiceSpecification one property of operation, include metric specifications.

type Sku 

type Sku struct {
	// Name - The name of the SKU, in standard format (such as S0). Possible values include: 'NameS0', 'NameS1', 'NameG2'
	Name Name `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 

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

MarshalJSON is the custom marshaler for Sku.

type SystemData 

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: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
	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: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
	LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"`
	// LastModifiedAt - The timestamp of resource last modification (UTC)
	LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}

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

type TrackedResource 

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 which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON 

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

MarshalJSON is the custom marshaler for TrackedResource.

Source Files

View all Source files

Directories

Path Synopsis

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.