extendedlocation

package
v68.0.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jan 19, 2023 License: MIT Imports: 10 Imported by: 153

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/extendedlocation/armextendedlocation(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/extendedlocation/armextendedlocation). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package extendedlocation implements the Azure ARM Extendedlocation service API version 2021-08-15.

The customLocations Rest API spec.

Index

Constants

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

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

type CustomLocation struct {
	autorest.Response `json:"-"`
	// Identity - Identity for the resource.
	Identity *Identity `json:"identity,omitempty"`
	// CustomLocationProperties - The set of properties specific to a Custom Location
	*CustomLocationProperties `json:"properties,omitempty"`
	// SystemData - READ-ONLY; Metadata pertaining to creation and last modification of the resource
	SystemData *SystemData `json:"systemData,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"`
}

CustomLocation custom Locations definition.

func (CustomLocation) MarshalJSON 

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

MarshalJSON is the custom marshaler for CustomLocation.

func (*CustomLocation) UnmarshalJSON 

func (cl *CustomLocation) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CustomLocation struct.

type CustomLocationListResult 

type CustomLocationListResult struct {
	autorest.Response `json:"-"`
	// NextLink - READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - READ-ONLY; The list of Custom Locations.
	Value *[]CustomLocation `json:"value,omitempty"`
}

CustomLocationListResult the List Custom Locations operation response.

func (CustomLocationListResult) IsEmpty 

func (cllr CustomLocationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (CustomLocationListResult) MarshalJSON 

func (cllr CustomLocationListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CustomLocationListResult.

type CustomLocationListResultIterator 

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

CustomLocationListResultIterator provides access to a complete listing of CustomLocation values.

func NewCustomLocationListResultIterator 

func NewCustomLocationListResultIterator(page CustomLocationListResultPage) CustomLocationListResultIterator

Creates a new instance of the CustomLocationListResultIterator type.

func (*CustomLocationListResultIterator) Next 

func (iter *CustomLocationListResultIterator) 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 (*CustomLocationListResultIterator) NextWithContext 

func (iter *CustomLocationListResultIterator) 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 (CustomLocationListResultIterator) NotDone 

func (iter CustomLocationListResultIterator) NotDone() bool

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

func (CustomLocationListResultIterator) Response 

func (iter CustomLocationListResultIterator) Response() CustomLocationListResult

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

func (CustomLocationListResultIterator) Value 

func (iter CustomLocationListResultIterator) Value() CustomLocation

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

type CustomLocationListResultPage 

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

CustomLocationListResultPage contains a page of CustomLocation values.

func NewCustomLocationListResultPage 

func NewCustomLocationListResultPage(cur CustomLocationListResult, getNextPage func(context.Context, CustomLocationListResult) (CustomLocationListResult, error)) CustomLocationListResultPage

Creates a new instance of the CustomLocationListResultPage type.

func (*CustomLocationListResultPage) Next 

func (page *CustomLocationListResultPage) 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 (*CustomLocationListResultPage) NextWithContext 

func (page *CustomLocationListResultPage) 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 (CustomLocationListResultPage) NotDone 

func (page CustomLocationListResultPage) NotDone() bool

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

func (CustomLocationListResultPage) Response 

func (page CustomLocationListResultPage) Response() CustomLocationListResult

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

func (CustomLocationListResultPage) Values 

func (page CustomLocationListResultPage) Values() []CustomLocation

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

type CustomLocationOperation 

type CustomLocationOperation struct {
	// CustomLocationOperationValueDisplay - Describes the properties of a Custom Locations Operation Value Display.
	*CustomLocationOperationValueDisplay `json:"display,omitempty"`
	// IsDataAction - READ-ONLY; Is this Operation a data plane operation
	IsDataAction *bool `json:"isDataAction,omitempty"`
	// Name - READ-ONLY; The name of the compute operation.
	Name *string `json:"name,omitempty"`
	// Origin - READ-ONLY; The origin of the compute operation.
	Origin *string `json:"origin,omitempty"`
}

CustomLocationOperation custom Locations operation.

func (CustomLocationOperation) MarshalJSON 

func (clo CustomLocationOperation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CustomLocationOperation.

func (*CustomLocationOperation) UnmarshalJSON 

func (clo *CustomLocationOperation) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CustomLocationOperation struct.

type CustomLocationOperationValueDisplay 

type CustomLocationOperationValueDisplay struct {
	// Description - READ-ONLY; The description of the operation.
	Description *string `json:"description,omitempty"`
	// Operation - READ-ONLY; The display name of the compute operation.
	Operation *string `json:"operation,omitempty"`
	// Provider - READ-ONLY; The resource provider for the operation.
	Provider *string `json:"provider,omitempty"`
	// Resource - READ-ONLY; The display name of the resource the operation applies to.
	Resource *string `json:"resource,omitempty"`
}

CustomLocationOperationValueDisplay describes the properties of a Custom Locations Operation Value Display.

func (CustomLocationOperationValueDisplay) MarshalJSON 

func (clovd CustomLocationOperationValueDisplay) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CustomLocationOperationValueDisplay.

type CustomLocationOperationsList 

type CustomLocationOperationsList struct {
	autorest.Response `json:"-"`
	// NextLink - Next page of operations.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - Array of customLocationOperation
	Value *[]CustomLocationOperation `json:"value,omitempty"`
}

CustomLocationOperationsList lists of Custom Locations operations.

func (CustomLocationOperationsList) IsEmpty 

func (clol CustomLocationOperationsList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CustomLocationOperationsListIterator 

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

CustomLocationOperationsListIterator provides access to a complete listing of CustomLocationOperation values.

func NewCustomLocationOperationsListIterator 

func NewCustomLocationOperationsListIterator(page CustomLocationOperationsListPage) CustomLocationOperationsListIterator

Creates a new instance of the CustomLocationOperationsListIterator type.

func (*CustomLocationOperationsListIterator) Next 

func (iter *CustomLocationOperationsListIterator) 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 (*CustomLocationOperationsListIterator) NextWithContext 

func (iter *CustomLocationOperationsListIterator) 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 (CustomLocationOperationsListIterator) NotDone 

func (iter CustomLocationOperationsListIterator) NotDone() bool

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

func (CustomLocationOperationsListIterator) Response 

func (iter CustomLocationOperationsListIterator) Response() CustomLocationOperationsList

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

func (CustomLocationOperationsListIterator) Value 

func (iter CustomLocationOperationsListIterator) Value() CustomLocationOperation

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

type CustomLocationOperationsListPage 

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

CustomLocationOperationsListPage contains a page of CustomLocationOperation values.

func NewCustomLocationOperationsListPage 

func NewCustomLocationOperationsListPage(cur CustomLocationOperationsList, getNextPage func(context.Context, CustomLocationOperationsList) (CustomLocationOperationsList, error)) CustomLocationOperationsListPage

Creates a new instance of the CustomLocationOperationsListPage type.

func (*CustomLocationOperationsListPage) Next 

func (page *CustomLocationOperationsListPage) 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 (*CustomLocationOperationsListPage) NextWithContext 

func (page *CustomLocationOperationsListPage) 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 (CustomLocationOperationsListPage) NotDone 

func (page CustomLocationOperationsListPage) NotDone() bool

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

func (CustomLocationOperationsListPage) Response 

func (page CustomLocationOperationsListPage) Response() CustomLocationOperationsList

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

func (CustomLocationOperationsListPage) Values 

func (page CustomLocationOperationsListPage) Values() []CustomLocationOperation

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

type CustomLocationProperties 

type CustomLocationProperties struct {
	// Authentication - This is optional input that contains the authentication that should be used to generate the namespace.
	Authentication *CustomLocationPropertiesAuthentication `json:"authentication,omitempty"`
	// ClusterExtensionIds - Contains the reference to the add-on that contains charts to deploy CRDs and operators.
	ClusterExtensionIds *[]string `json:"clusterExtensionIds,omitempty"`
	// DisplayName - Display name for the Custom Locations location.
	DisplayName *string `json:"displayName,omitempty"`
	// HostResourceID - Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions.
	HostResourceID *string `json:"hostResourceId,omitempty"`
	// HostType - Type of host the Custom Locations is referencing (Kubernetes, etc...). Possible values include: 'HostTypeKubernetes'
	HostType HostType `json:"hostType,omitempty"`
	// Namespace - Kubernetes namespace that will be created on the specified cluster.
	Namespace *string `json:"namespace,omitempty"`
	// ProvisioningState - Provisioning State for the Custom Location.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

CustomLocationProperties properties for a custom location.

type CustomLocationPropertiesAuthentication 

type CustomLocationPropertiesAuthentication struct {
	// Type - The type of the Custom Locations authentication
	Type *string `json:"type,omitempty"`
	// Value - The kubeconfig value.
	Value *string `json:"value,omitempty"`
}

CustomLocationPropertiesAuthentication this is optional input that contains the authentication that should be used to generate the namespace.

type CustomLocationsClient 

type CustomLocationsClient struct {
	BaseClient
}

CustomLocationsClient is the the customLocations Rest API spec.

func NewCustomLocationsClient 

func NewCustomLocationsClient(subscriptionID string) CustomLocationsClient

NewCustomLocationsClient creates an instance of the CustomLocationsClient client.

func NewCustomLocationsClientWithBaseURI 

func NewCustomLocationsClientWithBaseURI(baseURI string, subscriptionID string) CustomLocationsClient

NewCustomLocationsClientWithBaseURI creates an instance of the CustomLocationsClient 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 (CustomLocationsClient) CreateOrUpdate 

func (client CustomLocationsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, parameters CustomLocation) (result CustomLocationsCreateOrUpdateFuture, err error)

CreateOrUpdate creates or updates a Custom Location in the specified Subscription and Resource Group Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. resourceName - custom Locations name. parameters - parameters supplied to create or update a Custom Location.

func (CustomLocationsClient) CreateOrUpdatePreparer 

func (client CustomLocationsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, parameters CustomLocation) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (CustomLocationsClient) CreateOrUpdateResponder 

func (client CustomLocationsClient) CreateOrUpdateResponder(resp *http.Response) (result CustomLocation, err error)

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

func (CustomLocationsClient) CreateOrUpdateSender 

func (client CustomLocationsClient) CreateOrUpdateSender(req *http.Request) (future CustomLocationsCreateOrUpdateFuture, err error)

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

func (CustomLocationsClient) Delete 

func (client CustomLocationsClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result CustomLocationsDeleteFuture, err error)

Delete deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. resourceName - custom Locations name.

func (CustomLocationsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (CustomLocationsClient) DeleteResponder 

func (client CustomLocationsClient) 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 (CustomLocationsClient) DeleteSender 

func (client CustomLocationsClient) DeleteSender(req *http.Request) (future CustomLocationsDeleteFuture, err error)

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

func (CustomLocationsClient) Get 

func (client CustomLocationsClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result CustomLocation, err error)

Get gets the details of the customLocation with a specified resource group and name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. resourceName - custom Locations name.

func (CustomLocationsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (CustomLocationsClient) GetResponder 

func (client CustomLocationsClient) GetResponder(resp *http.Response) (result CustomLocation, err error)

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

func (CustomLocationsClient) GetSender 

func (client CustomLocationsClient) 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 (CustomLocationsClient) ListByResourceGroup 

func (client CustomLocationsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result CustomLocationListResultPage, err error)

ListByResourceGroup gets a list of Custom Locations in the specified subscription and resource group. The operation returns properties of each Custom Location. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive.

func (CustomLocationsClient) ListByResourceGroupComplete 

func (client CustomLocationsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result CustomLocationListResultIterator, err error)

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

func (CustomLocationsClient) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (CustomLocationsClient) ListByResourceGroupResponder 

func (client CustomLocationsClient) ListByResourceGroupResponder(resp *http.Response) (result CustomLocationListResult, err error)

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

func (CustomLocationsClient) ListByResourceGroupSender 

func (client CustomLocationsClient) 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 (CustomLocationsClient) ListBySubscription 

func (client CustomLocationsClient) ListBySubscription(ctx context.Context) (result CustomLocationListResultPage, err error)

ListBySubscription gets a list of Custom Locations in the specified subscription. The operation returns properties of each Custom Location

func (CustomLocationsClient) ListBySubscriptionComplete 

func (client CustomLocationsClient) ListBySubscriptionComplete(ctx context.Context) (result CustomLocationListResultIterator, err error)

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

func (CustomLocationsClient) ListBySubscriptionPreparer 

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

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (CustomLocationsClient) ListBySubscriptionResponder 

func (client CustomLocationsClient) ListBySubscriptionResponder(resp *http.Response) (result CustomLocationListResult, err error)

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

func (CustomLocationsClient) ListBySubscriptionSender 

func (client CustomLocationsClient) 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 (CustomLocationsClient) ListEnabledResourceTypes 

func (client CustomLocationsClient) ListEnabledResourceTypes(ctx context.Context, resourceGroupName string, resourceName string) (result EnabledResourceTypesListResultPage, err error)

ListEnabledResourceTypes gets the list of the Enabled Resource Types. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. resourceName - custom Locations name.

func (CustomLocationsClient) ListEnabledResourceTypesComplete 

func (client CustomLocationsClient) ListEnabledResourceTypesComplete(ctx context.Context, resourceGroupName string, resourceName string) (result EnabledResourceTypesListResultIterator, err error)

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

func (CustomLocationsClient) ListEnabledResourceTypesPreparer 

func (client CustomLocationsClient) ListEnabledResourceTypesPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

ListEnabledResourceTypesPreparer prepares the ListEnabledResourceTypes request.

func (CustomLocationsClient) ListEnabledResourceTypesResponder 

func (client CustomLocationsClient) ListEnabledResourceTypesResponder(resp *http.Response) (result EnabledResourceTypesListResult, err error)

ListEnabledResourceTypesResponder handles the response to the ListEnabledResourceTypes request. The method always closes the http.Response Body.

func (CustomLocationsClient) ListEnabledResourceTypesSender 

func (client CustomLocationsClient) ListEnabledResourceTypesSender(req *http.Request) (*http.Response, error)

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

func (CustomLocationsClient) ListOperations 

func (client CustomLocationsClient) ListOperations(ctx context.Context) (result CustomLocationOperationsListPage, err error)

ListOperations lists all available Custom Locations operations.

func (CustomLocationsClient) ListOperationsComplete 

func (client CustomLocationsClient) ListOperationsComplete(ctx context.Context) (result CustomLocationOperationsListIterator, err error)

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

func (CustomLocationsClient) ListOperationsPreparer 

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

ListOperationsPreparer prepares the ListOperations request.

func (CustomLocationsClient) ListOperationsResponder 

func (client CustomLocationsClient) ListOperationsResponder(resp *http.Response) (result CustomLocationOperationsList, err error)

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

func (CustomLocationsClient) ListOperationsSender 

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

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

func (CustomLocationsClient) Update 

func (client CustomLocationsClient) Update(ctx context.Context, resourceGroupName string, resourceName string, parameters PatchableCustomLocations) (result CustomLocation, err error)

Update updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. resourceName - custom Locations name. parameters - the updatable fields of an existing Custom Location.

func (CustomLocationsClient) UpdatePreparer 

func (client CustomLocationsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, parameters PatchableCustomLocations) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (CustomLocationsClient) UpdateResponder 

func (client CustomLocationsClient) UpdateResponder(resp *http.Response) (result CustomLocation, err error)

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

func (CustomLocationsClient) UpdateSender 

func (client CustomLocationsClient) 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 CustomLocationsCreateOrUpdateFuture 

type CustomLocationsCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CustomLocationsClient) (CustomLocation, error)
}

CustomLocationsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CustomLocationsCreateOrUpdateFuture) UnmarshalJSON 

func (future *CustomLocationsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CustomLocationsDeleteFuture 

type CustomLocationsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CustomLocationsClient) (autorest.Response, error)
}

CustomLocationsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CustomLocationsDeleteFuture) UnmarshalJSON 

func (future *CustomLocationsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type EnabledResourceType 

type EnabledResourceType struct {
	// EnabledResourceTypeProperties - The set of properties for EnabledResourceType specific to a Custom Location
	*EnabledResourceTypeProperties `json:"properties,omitempty"`
	// SystemData - READ-ONLY; Metadata pertaining to creation and last modification of the resource
	SystemData *SystemData `json:"systemData,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"`
}

EnabledResourceType enabledResourceType definition.

func (EnabledResourceType) MarshalJSON 

func (ert EnabledResourceType) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EnabledResourceType.

func (*EnabledResourceType) UnmarshalJSON 

func (ert *EnabledResourceType) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EnabledResourceType struct.

type EnabledResourceTypeProperties 

type EnabledResourceTypeProperties struct {
	// ClusterExtensionID - Cluster Extension ID
	ClusterExtensionID *string `json:"clusterExtensionId,omitempty"`
	// ExtensionType - Cluster Extension Type
	ExtensionType *string `json:"extensionType,omitempty"`
	// TypesMetadata - Metadata of the Resource Type
	TypesMetadata *[]EnabledResourceTypePropertiesTypesMetadataItem `json:"typesMetadata,omitempty"`
}

EnabledResourceTypeProperties properties for EnabledResourceType of a custom location.

type EnabledResourceTypePropertiesTypesMetadataItem 

type EnabledResourceTypePropertiesTypesMetadataItem struct {
	// APIVersion - Api Version of Resource Type
	APIVersion *string `json:"apiVersion,omitempty"`
	// ResourceProviderNamespace - Resource Provider Namespace of Resource Type
	ResourceProviderNamespace *string `json:"resourceProviderNamespace,omitempty"`
	// ResourceType - Resource Type
	ResourceType *string `json:"resourceType,omitempty"`
}

EnabledResourceTypePropertiesTypesMetadataItem metadata of the Resource Type.

type EnabledResourceTypesListResult 

type EnabledResourceTypesListResult struct {
	autorest.Response `json:"-"`
	// NextLink - READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - READ-ONLY; The list of EnabledResourceTypes available for a customLocation.
	Value *[]EnabledResourceType `json:"value,omitempty"`
}

EnabledResourceTypesListResult list of EnabledResourceTypes definition.

func (EnabledResourceTypesListResult) IsEmpty 

func (ertlr EnabledResourceTypesListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (EnabledResourceTypesListResult) MarshalJSON 

func (ertlr EnabledResourceTypesListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EnabledResourceTypesListResult.

type EnabledResourceTypesListResultIterator 

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

EnabledResourceTypesListResultIterator provides access to a complete listing of EnabledResourceType values.

func NewEnabledResourceTypesListResultIterator 

func NewEnabledResourceTypesListResultIterator(page EnabledResourceTypesListResultPage) EnabledResourceTypesListResultIterator

Creates a new instance of the EnabledResourceTypesListResultIterator type.

func (*EnabledResourceTypesListResultIterator) Next 

func (iter *EnabledResourceTypesListResultIterator) 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 (*EnabledResourceTypesListResultIterator) NextWithContext 

func (iter *EnabledResourceTypesListResultIterator) 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 (EnabledResourceTypesListResultIterator) NotDone 

func (iter EnabledResourceTypesListResultIterator) NotDone() bool

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

func (EnabledResourceTypesListResultIterator) Response 

func (iter EnabledResourceTypesListResultIterator) Response() EnabledResourceTypesListResult

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

func (EnabledResourceTypesListResultIterator) Value 

func (iter EnabledResourceTypesListResultIterator) Value() EnabledResourceType

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

type EnabledResourceTypesListResultPage 

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

EnabledResourceTypesListResultPage contains a page of EnabledResourceType values.

func NewEnabledResourceTypesListResultPage 

func NewEnabledResourceTypesListResultPage(cur EnabledResourceTypesListResult, getNextPage func(context.Context, EnabledResourceTypesListResult) (EnabledResourceTypesListResult, error)) EnabledResourceTypesListResultPage

Creates a new instance of the EnabledResourceTypesListResultPage type.

func (*EnabledResourceTypesListResultPage) Next 

func (page *EnabledResourceTypesListResultPage) 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 (*EnabledResourceTypesListResultPage) NextWithContext 

func (page *EnabledResourceTypesListResultPage) 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 (EnabledResourceTypesListResultPage) NotDone 

func (page EnabledResourceTypesListResultPage) NotDone() bool

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

func (EnabledResourceTypesListResultPage) Response 

func (page EnabledResourceTypesListResultPage) Response() EnabledResourceTypesListResult

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

func (EnabledResourceTypesListResultPage) Values 

func (page EnabledResourceTypesListResultPage) Values() []EnabledResourceType

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

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 HostType 

type HostType string

HostType enumerates the values for host type. 

const (
	// HostTypeKubernetes ...
	HostTypeKubernetes HostType = "Kubernetes"
)

func PossibleHostTypeValues 

func PossibleHostTypeValues() []HostType

PossibleHostTypeValues returns an array of possible values for the HostType const type.

type Identity 

type Identity struct {
	// PrincipalID - READ-ONLY; The principal ID of resource identity.
	PrincipalID *string `json:"principalId,omitempty"`
	// TenantID - READ-ONLY; The tenant ID of resource.
	TenantID *string `json:"tenantId,omitempty"`
	// Type - The identity type. Possible values include: 'ResourceIdentityTypeSystemAssigned', 'ResourceIdentityTypeNone'
	Type ResourceIdentityType `json:"type,omitempty"`
}

Identity identity for the resource.

func (Identity) MarshalJSON 

func (i Identity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Identity.

type PatchableCustomLocations 

type PatchableCustomLocations struct {
	// Identity - Identity for the resource.
	Identity *Identity `json:"identity,omitempty"`
	// CustomLocationProperties - The Custom Locations patchable properties.
	*CustomLocationProperties `json:"properties,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

PatchableCustomLocations the Custom Locations patchable resource definition.

func (PatchableCustomLocations) MarshalJSON 

func (pcl PatchableCustomLocations) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PatchableCustomLocations.

func (*PatchableCustomLocations) UnmarshalJSON 

func (pcl *PatchableCustomLocations) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PatchableCustomLocations struct.

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 ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType enumerates the values for resource identity type. 

const (
	// ResourceIdentityTypeNone ...
	ResourceIdentityTypeNone ResourceIdentityType = "None"
	// ResourceIdentityTypeSystemAssigned ...
	ResourceIdentityTypeSystemAssigned ResourceIdentityType = "SystemAssigned"
)

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.

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
Deprecated: Please note, this package has been deprecated.
 Deprecated: Please note, this package has been deprecated.

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.