Documentation ¶
Overview ¶
Package maps implements the Azure ARM Maps service API version 2020-02-01-preview.
Resource Provider
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type Account
- type AccountCreateParameters
- type AccountKeys
- type AccountProperties
- type AccountUpdateParameters
- type Accounts
- type AccountsClient
- func (client AccountsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, ...) (result Account, err error)
- func (client AccountsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountsClient) CreateOrUpdateResponder(resp *http.Response) (result Account, err error)
- func (client AccountsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result autorest.Response, err error)
- func (client AccountsClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
- func (client AccountsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client AccountsClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result Account, err error)
- func (client AccountsClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
- func (client AccountsClient) GetResponder(resp *http.Response) (result Account, err error)
- func (client AccountsClient) GetSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result Accounts, err error)
- func (client AccountsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client AccountsClient) ListByResourceGroupResponder(resp *http.Response) (result Accounts, err error)
- func (client AccountsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) ListBySubscription(ctx context.Context) (result Accounts, err error)
- func (client AccountsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
- func (client AccountsClient) ListBySubscriptionResponder(resp *http.Response) (result Accounts, err error)
- func (client AccountsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) ListKeys(ctx context.Context, resourceGroupName string, accountName string) (result AccountKeys, err error)
- func (client AccountsClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
- func (client AccountsClient) ListKeysResponder(resp *http.Response) (result AccountKeys, err error)
- func (client AccountsClient) ListKeysSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) RegenerateKeys(ctx context.Context, resourceGroupName string, accountName string, ...) (result AccountKeys, err error)
- func (client AccountsClient) RegenerateKeysPreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountsClient) RegenerateKeysResponder(resp *http.Response) (result AccountKeys, err error)
- func (client AccountsClient) RegenerateKeysSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) Update(ctx context.Context, resourceGroupName string, accountName string, ...) (result Account, err error)
- func (client AccountsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountsClient) UpdateResponder(resp *http.Response) (result Account, err error)
- func (client AccountsClient) UpdateSender(req *http.Request) (*http.Response, error)
- type AzureEntityResource
- type BaseClient
- type Client
- func (client Client) ListOperations(ctx context.Context) (result Operations, err error)
- func (client Client) ListOperationsPreparer(ctx context.Context) (*http.Request, error)
- func (client Client) ListOperationsResponder(resp *http.Response) (result Operations, err error)
- func (client Client) ListOperationsSender(req *http.Request) (*http.Response, error)
- type CreatedByType
- type ErrorAdditionalInfo
- type ErrorResponse
- type KeySpecification
- type KeyType
- type Operations
- type OperationsValueItem
- type OperationsValueItemDisplay
- type PrivateAtlas
- type PrivateAtlasCreateParameters
- type PrivateAtlasList
- type PrivateAtlasProperties
- type PrivateAtlasUpdateParameters
- type PrivateAtlasesClient
- func (client PrivateAtlasesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, ...) (result PrivateAtlas, err error)
- func (client PrivateAtlasesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client PrivateAtlasesClient) CreateOrUpdateResponder(resp *http.Response) (result PrivateAtlas, err error)
- func (client PrivateAtlasesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client PrivateAtlasesClient) Delete(ctx context.Context, resourceGroupName string, accountName string, ...) (result autorest.Response, err error)
- func (client PrivateAtlasesClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client PrivateAtlasesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client PrivateAtlasesClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client PrivateAtlasesClient) Get(ctx context.Context, resourceGroupName string, accountName string, ...) (result PrivateAtlas, err error)
- func (client PrivateAtlasesClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client PrivateAtlasesClient) GetResponder(resp *http.Response) (result PrivateAtlas, err error)
- func (client PrivateAtlasesClient) GetSender(req *http.Request) (*http.Response, error)
- func (client PrivateAtlasesClient) ListByAccount(ctx context.Context, resourceGroupName string, accountName string) (result PrivateAtlasList, err error)
- func (client PrivateAtlasesClient) ListByAccountPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
- func (client PrivateAtlasesClient) ListByAccountResponder(resp *http.Response) (result PrivateAtlasList, err error)
- func (client PrivateAtlasesClient) ListByAccountSender(req *http.Request) (*http.Response, error)
- func (client PrivateAtlasesClient) Update(ctx context.Context, resourceGroupName string, accountName string, ...) (result PrivateAtlas, err error)
- func (client PrivateAtlasesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client PrivateAtlasesClient) UpdateResponder(resp *http.Response) (result PrivateAtlas, err error)
- func (client PrivateAtlasesClient) UpdateSender(req *http.Request) (*http.Response, error)
- type ProxyResource
- type Resource
- type Sku
- type SystemData
- type TrackedResource
Constants ¶
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 - 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. Ex- 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 ¶
MarshalJSON is the custom marshaler for Account.
type AccountCreateParameters ¶
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 ¶
func (acp AccountCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccountCreateParameters.
type AccountKeys ¶
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 ¶
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 ¶
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 ¶
func (aup AccountUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccountUpdateParameters.
type Accounts ¶
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 ¶
type AccountsClient struct {
BaseClient
}
AccountsClient is the resource Provider
func NewAccountsClient ¶
func NewAccountsClient(subscriptionID string) AccountsClient
NewAccountsClient creates an instance of the AccountsClient client.
func NewAccountsClientWithBaseURI ¶
func NewAccountsClientWithBaseURI(baseURI string, subscriptionID string) AccountsClient
NewAccountsClientWithBaseURI creates an instance of the AccountsClient client 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, 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 ¶
func (client AccountsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, mapsAccountCreateParameters AccountCreateParameters) (*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 ¶
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 ¶
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 ¶
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 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 ¶
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 ¶
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 Accounts, err error)
ListBySubscription get all Maps Accounts in a Subscription
func (AccountsClient) ListBySubscriptionPreparer ¶
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 ¶
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 ¶
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 ¶
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 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 ¶
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 ¶
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. Type *string `json:"type,omitempty"` }
AzureEntityResource the resource model definition for a Azure Resource Manager resource with an etag.
type BaseClient ¶
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 resource Provider
func NewClientWithBaseURI ¶
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 Operations, err error)
ListOperations list operations available for the Maps Resource Provider
func (Client) ListOperationsPreparer ¶
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.
type CreatedByType ¶
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 ¶
func PossibleCreatedByTypeValues() []CreatedByType
PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.
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.
type ErrorResponse ¶
type ErrorResponse 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 *[]ErrorResponse `json:"details,omitempty"` // AdditionalInfo - READ-ONLY; The error additional info. AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"` }
ErrorResponse the resource management error response.
type KeySpecification ¶
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 ¶
type KeyType string
KeyType enumerates the values for key type.
func PossibleKeyTypeValues ¶
func PossibleKeyTypeValues() []KeyType
PossibleKeyTypeValues returns an array of possible values for the KeyType const type.
type Operations ¶
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 ¶
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 ...
type OperationsValueItemDisplay ¶
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 ¶
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. Ex- 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 ¶
func (pa PrivateAtlas) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateAtlas.
type PrivateAtlasCreateParameters ¶
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 ¶
func (pacp PrivateAtlasCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateAtlasCreateParameters.
type PrivateAtlasList ¶
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 ¶
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 ¶
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 ¶
func (paup PrivateAtlasUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateAtlasUpdateParameters.
type PrivateAtlasesClient ¶
type PrivateAtlasesClient struct {
BaseClient
}
PrivateAtlasesClient is the resource Provider
func NewPrivateAtlasesClient ¶
func NewPrivateAtlasesClient(subscriptionID string) PrivateAtlasesClient
NewPrivateAtlasesClient creates an instance of the PrivateAtlasesClient client.
func NewPrivateAtlasesClientWithBaseURI ¶
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 ¶
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 ¶
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 ¶
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 ¶
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (PrivateAtlasesClient) Delete ¶
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 ¶
func (client PrivateAtlasesClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, privateAtlasName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (PrivateAtlasesClient) DeleteResponder ¶
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 ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (PrivateAtlasesClient) Get ¶
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 ¶
func (client PrivateAtlasesClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, privateAtlasName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (PrivateAtlasesClient) GetResponder ¶
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 ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (PrivateAtlasesClient) ListByAccount ¶
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 ¶
func (client PrivateAtlasesClient) ListByAccountPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListByAccountPreparer prepares the ListByAccount request.
func (PrivateAtlasesClient) ListByAccountResponder ¶
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 ¶
ListByAccountSender sends the ListByAccount request. The method will close the http.Response Body if it receives an error.
func (PrivateAtlasesClient) Update ¶
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 ¶
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 ¶
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 ¶
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. Type *string `json:"type,omitempty"` }
ProxyResource the resource model definition for a ARM proxy resource. It will have everything other than required location and tags
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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. Type *string `json:"type,omitempty"` }
Resource ...
type Sku ¶
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.
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: '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 ¶
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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. Type *string `json:"type,omitempty"` }
TrackedResource the resource model definition for a ARM tracked top level resource
func (TrackedResource) MarshalJSON ¶
func (tr TrackedResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TrackedResource.