const (
// DefaultBaseURI is the default URI used for the service Customproviders
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
ActionRouting enumerates the values for action routing.
type ActionRouting string
const (
// Proxy ...
Proxy ActionRouting = "Proxy"
)
func PossibleActionRoutingValues() []ActionRouting
PossibleActionRoutingValues returns an array of possible values for the ActionRouting const type.
Association the resource definition of this association.
type Association struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; The association id.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The association name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The association type.
Type *string `json:"type,omitempty"`
// AssociationProperties - The properties of the association.
*AssociationProperties `json:"properties,omitempty"`
}
func (a Association) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Association.
func (a *Association) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Association struct.
AssociationProperties the properties of the association.
type AssociationProperties struct {
// TargetResourceID - The REST resource instance of the target resource for this association.
TargetResourceID *string `json:"targetResourceId,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state of the association. Possible values include: 'Accepted', 'Deleting', 'Running', 'Succeeded', 'Failed'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}
func (a AssociationProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AssociationProperties.
AssociationsClient is the allows extension of ARM control plane with custom resource providers.
type AssociationsClient struct {
BaseClient
}
func NewAssociationsClient(subscriptionID string) AssociationsClient
NewAssociationsClient creates an instance of the AssociationsClient client.
func NewAssociationsClientWithBaseURI(baseURI string, subscriptionID string) AssociationsClient
NewAssociationsClientWithBaseURI creates an instance of the AssociationsClient 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 AssociationsClient) CreateOrUpdate(ctx context.Context, scope string, associationName string, association Association) (result AssociationsCreateOrUpdateFuture, err error)
CreateOrUpdate create or update an association. Parameters: scope - the scope of the association. The scope can be any valid REST resource instance. For example, use '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Compute/virtualMachines/{vm-name}' for a virtual machine resource. associationName - the name of the association. association - the parameters required to create or update an association.
func (client AssociationsClient) CreateOrUpdatePreparer(ctx context.Context, scope string, associationName string, association Association) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client AssociationsClient) CreateOrUpdateResponder(resp *http.Response) (result Association, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client AssociationsClient) CreateOrUpdateSender(req *http.Request) (future AssociationsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client AssociationsClient) Delete(ctx context.Context, scope string, associationName string) (result AssociationsDeleteFuture, err error)
Delete delete an association. Parameters: scope - the scope of the association. associationName - the name of the association.
func (client AssociationsClient) DeletePreparer(ctx context.Context, scope string, associationName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client AssociationsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client AssociationsClient) DeleteSender(req *http.Request) (future AssociationsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client AssociationsClient) Get(ctx context.Context, scope string, associationName string) (result Association, err error)
Get get an association. Parameters: scope - the scope of the association. associationName - the name of the association.
func (client AssociationsClient) GetPreparer(ctx context.Context, scope string, associationName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client AssociationsClient) GetResponder(resp *http.Response) (result Association, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client AssociationsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client AssociationsClient) ListAll(ctx context.Context, scope string) (result AssociationsListPage, err error)
ListAll gets all association for the given scope. Parameters: scope - the scope of the association.
func (client AssociationsClient) ListAllComplete(ctx context.Context, scope string) (result AssociationsListIterator, err error)
ListAllComplete enumerates all values, automatically crossing page boundaries as required.
func (client AssociationsClient) ListAllPreparer(ctx context.Context, scope string) (*http.Request, error)
ListAllPreparer prepares the ListAll request.
func (client AssociationsClient) ListAllResponder(resp *http.Response) (result AssociationsList, err error)
ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.
func (client AssociationsClient) ListAllSender(req *http.Request) (*http.Response, error)
ListAllSender sends the ListAll request. The method will close the http.Response Body if it receives an error.
AssociationsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type AssociationsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(AssociationsClient) (Association, error)
}
func (future *AssociationsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
AssociationsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type AssociationsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(AssociationsClient) (autorest.Response, error)
}
func (future *AssociationsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
AssociationsList list of associations.
type AssociationsList struct {
autorest.Response `json:"-"`
// Value - The array of associations.
Value *[]Association `json:"value,omitempty"`
// NextLink - The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (al AssociationsList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
AssociationsListIterator provides access to a complete listing of Association values.
type AssociationsListIterator struct {
// contains filtered or unexported fields
}
func NewAssociationsListIterator(page AssociationsListPage) AssociationsListIterator
Creates a new instance of the AssociationsListIterator type.
func (iter *AssociationsListIterator) 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 (iter *AssociationsListIterator) 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 (iter AssociationsListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AssociationsListIterator) Response() AssociationsList
Response returns the raw server response from the last page request.
func (iter AssociationsListIterator) Value() Association
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
AssociationsListPage contains a page of Association values.
type AssociationsListPage struct {
// contains filtered or unexported fields
}
func NewAssociationsListPage(cur AssociationsList, getNextPage func(context.Context, AssociationsList) (AssociationsList, error)) AssociationsListPage
Creates a new instance of the AssociationsListPage type.
func (page *AssociationsListPage) 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 (page *AssociationsListPage) 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 (page AssociationsListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AssociationsListPage) Response() AssociationsList
Response returns the raw server response from the last page request.
func (page AssociationsListPage) Values() []Association
Values returns the slice of values for the current page or nil if there are no values.
BaseClient is the base client for Customproviders.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
CustomRPActionRouteDefinition the route definition for an action implemented by the custom resource provider.
type CustomRPActionRouteDefinition struct {
// RoutingType - The routing types that are supported for action requests. Possible values include: 'Proxy'
RoutingType ActionRouting `json:"routingType,omitempty"`
// Name - The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')
Name *string `json:"name,omitempty"`
// Endpoint - The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')
Endpoint *string `json:"endpoint,omitempty"`
}
CustomRPManifest a manifest file that defines the custom resource provider resources.
type CustomRPManifest struct {
autorest.Response `json:"-"`
// CustomRPManifestProperties - The manifest for the custom resource provider
*CustomRPManifestProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (crm CustomRPManifest) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CustomRPManifest.
func (crm *CustomRPManifest) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CustomRPManifest struct.
CustomRPManifestProperties the manifest for the custom resource provider
type CustomRPManifestProperties struct {
// Actions - A list of actions that the custom resource provider implements.
Actions *[]CustomRPActionRouteDefinition `json:"actions,omitempty"`
// ResourceTypes - A list of resource types that the custom resource provider implements.
ResourceTypes *[]CustomRPResourceTypeRouteDefinition `json:"resourceTypes,omitempty"`
// Validations - A list of validations to run on the custom resource provider's requests.
Validations *[]CustomRPValidations `json:"validations,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state of the resource provider. Possible values include: 'Accepted', 'Deleting', 'Running', 'Succeeded', 'Failed'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}
func (crm CustomRPManifestProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CustomRPManifestProperties.
CustomRPResourceTypeRouteDefinition the route definition for a resource implemented by the custom resource provider.
type CustomRPResourceTypeRouteDefinition struct {
// RoutingType - The routing types that are supported for resource requests. Possible values include: 'ResourceTypeRoutingProxy', 'ResourceTypeRoutingProxyCache'
RoutingType ResourceTypeRouting `json:"routingType,omitempty"`
// Name - The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')
Name *string `json:"name,omitempty"`
// Endpoint - The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')
Endpoint *string `json:"endpoint,omitempty"`
}
CustomRPRouteDefinition a route definition that defines an action or resource that can be interacted with through the custom resource provider.
type CustomRPRouteDefinition struct {
// Name - The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')
Name *string `json:"name,omitempty"`
// Endpoint - The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')
Endpoint *string `json:"endpoint,omitempty"`
}
CustomRPValidations a validation to apply on custom resource provider requests.
type CustomRPValidations struct {
// ValidationType - The type of validation to run against a matching request. Possible values include: 'Swagger'
ValidationType ValidationType `json:"validationType,omitempty"`
// Specification - A link to the validation specification. The specification must be hosted on raw.githubusercontent.com.
Specification *string `json:"specification,omitempty"`
}
CustomResourceProviderClient is the allows extension of ARM control plane with custom resource providers.
type CustomResourceProviderClient struct {
BaseClient
}
func NewCustomResourceProviderClient(subscriptionID string) CustomResourceProviderClient
NewCustomResourceProviderClient creates an instance of the CustomResourceProviderClient client.
func NewCustomResourceProviderClientWithBaseURI(baseURI string, subscriptionID string) CustomResourceProviderClient
NewCustomResourceProviderClientWithBaseURI creates an instance of the CustomResourceProviderClient 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 CustomResourceProviderClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceProviderName string, resourceProvider CustomRPManifest) (result CustomResourceProviderCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates the custom resource provider. Parameters: resourceGroupName - the name of the resource group. resourceProviderName - the name of the resource provider. resourceProvider - the parameters required to create or update a custom resource provider definition.
func (client CustomResourceProviderClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceProviderName string, resourceProvider CustomRPManifest) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client CustomResourceProviderClient) CreateOrUpdateResponder(resp *http.Response) (result CustomRPManifest, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client CustomResourceProviderClient) CreateOrUpdateSender(req *http.Request) (future CustomResourceProviderCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client CustomResourceProviderClient) Delete(ctx context.Context, resourceGroupName string, resourceProviderName string) (result CustomResourceProviderDeleteFuture, err error)
Delete deletes the custom resource provider. Parameters: resourceGroupName - the name of the resource group. resourceProviderName - the name of the resource provider.
func (client CustomResourceProviderClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceProviderName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client CustomResourceProviderClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client CustomResourceProviderClient) DeleteSender(req *http.Request) (future CustomResourceProviderDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client CustomResourceProviderClient) Get(ctx context.Context, resourceGroupName string, resourceProviderName string) (result CustomRPManifest, err error)
Get gets the custom resource provider manifest. Parameters: resourceGroupName - the name of the resource group. resourceProviderName - the name of the resource provider.
func (client CustomResourceProviderClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceProviderName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client CustomResourceProviderClient) GetResponder(resp *http.Response) (result CustomRPManifest, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client CustomResourceProviderClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client CustomResourceProviderClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ListByCustomRPManifestPage, err error)
ListByResourceGroup gets all the custom resource providers within a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client CustomResourceProviderClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ListByCustomRPManifestIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client CustomResourceProviderClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client CustomResourceProviderClient) ListByResourceGroupResponder(resp *http.Response) (result ListByCustomRPManifest, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client CustomResourceProviderClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client CustomResourceProviderClient) ListBySubscription(ctx context.Context) (result ListByCustomRPManifestPage, err error)
ListBySubscription gets all the custom resource providers within a subscription.
func (client CustomResourceProviderClient) ListBySubscriptionComplete(ctx context.Context) (result ListByCustomRPManifestIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client CustomResourceProviderClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client CustomResourceProviderClient) ListBySubscriptionResponder(resp *http.Response) (result ListByCustomRPManifest, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client CustomResourceProviderClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (client CustomResourceProviderClient) Update(ctx context.Context, resourceGroupName string, resourceProviderName string, patchableResource ResourceProvidersUpdate) (result CustomRPManifest, err error)
Update updates an existing custom resource provider. The only value that can be updated via PATCH currently is the tags. Parameters: resourceGroupName - the name of the resource group. resourceProviderName - the name of the resource provider. patchableResource - the updatable fields of a custom resource provider.
func (client CustomResourceProviderClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceProviderName string, patchableResource ResourceProvidersUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client CustomResourceProviderClient) UpdateResponder(resp *http.Response) (result CustomRPManifest, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client CustomResourceProviderClient) 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.
CustomResourceProviderCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CustomResourceProviderCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CustomResourceProviderClient) (CustomRPManifest, error)
}
func (future *CustomResourceProviderCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CustomResourceProviderDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CustomResourceProviderDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CustomResourceProviderClient) (autorest.Response, error)
}
func (future *CustomResourceProviderDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ErrorDefinition error definition.
type ErrorDefinition struct {
// Code - READ-ONLY; Service specific error code which serves as the substatus for the HTTP error code.
Code *string `json:"code,omitempty"`
// Message - READ-ONLY; Description of the error.
Message *string `json:"message,omitempty"`
// Details - READ-ONLY; Internal error details.
Details *[]ErrorDefinition `json:"details,omitempty"`
}
func (ed ErrorDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorDefinition.
ErrorResponse error response.
type ErrorResponse struct {
// Error - The error details.
Error *ErrorDefinition `json:"error,omitempty"`
}
ListByCustomRPManifest list of custom resource providers.
type ListByCustomRPManifest struct {
autorest.Response `json:"-"`
// Value - The array of custom resource provider manifests.
Value *[]CustomRPManifest `json:"value,omitempty"`
// NextLink - The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (lbcrm ListByCustomRPManifest) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ListByCustomRPManifestIterator provides access to a complete listing of CustomRPManifest values.
type ListByCustomRPManifestIterator struct {
// contains filtered or unexported fields
}
func NewListByCustomRPManifestIterator(page ListByCustomRPManifestPage) ListByCustomRPManifestIterator
Creates a new instance of the ListByCustomRPManifestIterator type.
func (iter *ListByCustomRPManifestIterator) 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 (iter *ListByCustomRPManifestIterator) 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 (iter ListByCustomRPManifestIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListByCustomRPManifestIterator) Response() ListByCustomRPManifest
Response returns the raw server response from the last page request.
func (iter ListByCustomRPManifestIterator) Value() CustomRPManifest
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ListByCustomRPManifestPage contains a page of CustomRPManifest values.
type ListByCustomRPManifestPage struct {
// contains filtered or unexported fields
}
func NewListByCustomRPManifestPage(cur ListByCustomRPManifest, getNextPage func(context.Context, ListByCustomRPManifest) (ListByCustomRPManifest, error)) ListByCustomRPManifestPage
Creates a new instance of the ListByCustomRPManifestPage type.
func (page *ListByCustomRPManifestPage) 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 (page *ListByCustomRPManifestPage) 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 (page ListByCustomRPManifestPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListByCustomRPManifestPage) Response() ListByCustomRPManifest
Response returns the raw server response from the last page request.
func (page ListByCustomRPManifestPage) Values() []CustomRPManifest
Values returns the slice of values for the current page or nil if there are no values.
OperationsClient is the allows extension of ARM control plane with custom resource providers.
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient 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 OperationsClient) List(ctx context.Context) (result ResourceProviderOperationListPage, err error)
List the list of operations provided by Microsoft CustomProviders.
func (client OperationsClient) ListComplete(ctx context.Context) (result ResourceProviderOperationListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result ResourceProviderOperationList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
ProvisioningState enumerates the values for provisioning state.
type ProvisioningState string
const (
// Accepted ...
Accepted ProvisioningState = "Accepted"
// Deleting ...
Deleting ProvisioningState = "Deleting"
// Failed ...
Failed ProvisioningState = "Failed"
// Running ...
Running ProvisioningState = "Running"
// Succeeded ...
Succeeded ProvisioningState = "Succeeded"
)
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
Resource the resource definition.
type Resource struct {
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
ResourceProviderOperation supported operations of this resource provider.
type ResourceProviderOperation struct {
// Name - Operation name, in format of {provider}/{resource}/{operation}
Name *string `json:"name,omitempty"`
// Display - Display metadata associated with the operation.
Display *ResourceProviderOperationDisplay `json:"display,omitempty"`
}
ResourceProviderOperationDisplay display metadata associated with the operation.
type ResourceProviderOperationDisplay struct {
// Provider - Resource provider: Microsoft Custom Providers.
Provider *string `json:"provider,omitempty"`
// Resource - Resource on which the operation is performed.
Resource *string `json:"resource,omitempty"`
// Operation - Type of operation: get, read, delete, etc.
Operation *string `json:"operation,omitempty"`
// Description - Description of this operation.
Description *string `json:"description,omitempty"`
}
ResourceProviderOperationList results of the request to list operations.
type ResourceProviderOperationList struct {
autorest.Response `json:"-"`
// Value - List of operations supported by this resource provider.
Value *[]ResourceProviderOperation `json:"value,omitempty"`
// NextLink - The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (rpol ResourceProviderOperationList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ResourceProviderOperationListIterator provides access to a complete listing of ResourceProviderOperation values.
type ResourceProviderOperationListIterator struct {
// contains filtered or unexported fields
}
func NewResourceProviderOperationListIterator(page ResourceProviderOperationListPage) ResourceProviderOperationListIterator
Creates a new instance of the ResourceProviderOperationListIterator type.
func (iter *ResourceProviderOperationListIterator) 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 (iter *ResourceProviderOperationListIterator) 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 (iter ResourceProviderOperationListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ResourceProviderOperationListIterator) Response() ResourceProviderOperationList
Response returns the raw server response from the last page request.
func (iter ResourceProviderOperationListIterator) Value() ResourceProviderOperation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ResourceProviderOperationListPage contains a page of ResourceProviderOperation values.
type ResourceProviderOperationListPage struct {
// contains filtered or unexported fields
}
func NewResourceProviderOperationListPage(cur ResourceProviderOperationList, getNextPage func(context.Context, ResourceProviderOperationList) (ResourceProviderOperationList, error)) ResourceProviderOperationListPage
Creates a new instance of the ResourceProviderOperationListPage type.
func (page *ResourceProviderOperationListPage) 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 (page *ResourceProviderOperationListPage) 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 (page ResourceProviderOperationListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ResourceProviderOperationListPage) Response() ResourceProviderOperationList
Response returns the raw server response from the last page request.
func (page ResourceProviderOperationListPage) Values() []ResourceProviderOperation
Values returns the slice of values for the current page or nil if there are no values.
ResourceProvidersUpdate custom resource provider update information.
type ResourceProvidersUpdate struct {
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (rpu ResourceProvidersUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceProvidersUpdate.
ResourceTypeRouting enumerates the values for resource type routing.
type ResourceTypeRouting string
const (
// ResourceTypeRoutingProxy ...
ResourceTypeRoutingProxy ResourceTypeRouting = "Proxy"
// ResourceTypeRoutingProxyCache ...
ResourceTypeRoutingProxyCache ResourceTypeRouting = "Proxy,Cache"
)
func PossibleResourceTypeRoutingValues() []ResourceTypeRouting
PossibleResourceTypeRoutingValues returns an array of possible values for the ResourceTypeRouting const type.
ValidationType enumerates the values for validation type.
type ValidationType string
const (
// Swagger ...
Swagger ValidationType = "Swagger"
)
func PossibleValidationTypeValues() []ValidationType
PossibleValidationTypeValues returns an array of possible values for the ValidationType const type.
| Name | Synopsis |
|---|---|
| .. | |
| customprovidersapi | Deprecated: Please note, this package has been deprecated. |