azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/preview/customproviders/mgmt/2018-09-01-preview/customproviders Index | Files | Directories

package customproviders

import "github.com/Azure/azure-sdk-for-go/services/preview/customproviders/mgmt/2018-09-01-preview/customproviders"

Package customproviders implements the Azure ARM Customproviders service API version 2018-09-01-preview.

Allows extension of ARM control plane with custom resource providers.

Index

Package Files

associations.go client.go customresourceprovider.go models.go operations.go version.go

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type ActionRouting Uses

type ActionRouting string

ActionRouting enumerates the values for action routing.

const (
    // Proxy ...
    Proxy ActionRouting = "Proxy"
)

func PossibleActionRoutingValues Uses

func PossibleActionRoutingValues() []ActionRouting

PossibleActionRoutingValues returns an array of possible values for the ActionRouting const type.

type Association Uses

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

Association the resource definition of this association.

func (Association) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Association.

func (*Association) UnmarshalJSON Uses

func (a *Association) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Association struct.

type AssociationProperties Uses

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

AssociationProperties the properties of the association.

type AssociationsClient Uses

type AssociationsClient struct {
    BaseClient
}

AssociationsClient is the allows extension of ARM control plane with custom resource providers.

func NewAssociationsClient Uses

func NewAssociationsClient(subscriptionID string) AssociationsClient

NewAssociationsClient creates an instance of the AssociationsClient client.

func NewAssociationsClientWithBaseURI Uses

func NewAssociationsClientWithBaseURI(baseURI string, subscriptionID string) AssociationsClient

NewAssociationsClientWithBaseURI creates an instance of the AssociationsClient client.

func (AssociationsClient) CreateOrUpdate Uses

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 (AssociationsClient) CreateOrUpdatePreparer Uses

func (client AssociationsClient) CreateOrUpdatePreparer(ctx context.Context, scope string, associationName string, association Association) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AssociationsClient) CreateOrUpdateResponder Uses

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

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 (AssociationsClient) Delete Uses

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 (AssociationsClient) DeletePreparer Uses

func (client AssociationsClient) DeletePreparer(ctx context.Context, scope string, associationName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (AssociationsClient) DeleteResponder Uses

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 (AssociationsClient) DeleteSender Uses

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 (AssociationsClient) Get Uses

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 (AssociationsClient) GetPreparer Uses

func (client AssociationsClient) GetPreparer(ctx context.Context, scope string, associationName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AssociationsClient) GetResponder Uses

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

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 (AssociationsClient) ListAll Uses

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 (AssociationsClient) ListAllComplete Uses

func (client AssociationsClient) ListAllComplete(ctx context.Context, scope string) (result AssociationsListIterator, err error)

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

func (AssociationsClient) ListAllPreparer Uses

func (client AssociationsClient) ListAllPreparer(ctx context.Context, scope string) (*http.Request, error)

ListAllPreparer prepares the ListAll request.

func (AssociationsClient) ListAllResponder Uses

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 (AssociationsClient) ListAllSender Uses

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.

type AssociationsCreateOrUpdateFuture Uses

type AssociationsCreateOrUpdateFuture struct {
    azure.Future
}

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

func (*AssociationsCreateOrUpdateFuture) Result Uses

func (future *AssociationsCreateOrUpdateFuture) Result(client AssociationsClient) (a Association, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type AssociationsDeleteFuture Uses

type AssociationsDeleteFuture struct {
    azure.Future
}

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

func (*AssociationsDeleteFuture) Result Uses

func (future *AssociationsDeleteFuture) Result(client AssociationsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type AssociationsList Uses

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

AssociationsList list of associations.

func (AssociationsList) IsEmpty Uses

func (al AssociationsList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AssociationsListIterator Uses

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

AssociationsListIterator provides access to a complete listing of Association values.

func NewAssociationsListIterator Uses

func NewAssociationsListIterator(page AssociationsListPage) AssociationsListIterator

Creates a new instance of the AssociationsListIterator type.

func (*AssociationsListIterator) Next Uses

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 (*AssociationsListIterator) NextWithContext Uses

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 (AssociationsListIterator) NotDone Uses

func (iter AssociationsListIterator) NotDone() bool

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

func (AssociationsListIterator) Response Uses

func (iter AssociationsListIterator) Response() AssociationsList

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

func (AssociationsListIterator) Value Uses

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.

type AssociationsListPage Uses

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

AssociationsListPage contains a page of Association values.

func NewAssociationsListPage Uses

func NewAssociationsListPage(getNextPage func(context.Context, AssociationsList) (AssociationsList, error)) AssociationsListPage

Creates a new instance of the AssociationsListPage type.

func (*AssociationsListPage) Next Uses

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 (*AssociationsListPage) NextWithContext Uses

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 (AssociationsListPage) NotDone Uses

func (page AssociationsListPage) NotDone() bool

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

func (AssociationsListPage) Response Uses

func (page AssociationsListPage) Response() AssociationsList

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

func (AssociationsListPage) Values Uses

func (page AssociationsListPage) Values() []Association

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

type BaseClient Uses

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

BaseClient is the base client for Customproviders.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type CustomRPActionRouteDefinition Uses

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

CustomRPActionRouteDefinition the route definition for an action implemented by the custom resource provider.

type CustomRPManifest Uses

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

CustomRPManifest a manifest file that defines the custom resource provider resources.

func (CustomRPManifest) MarshalJSON Uses

func (crm CustomRPManifest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CustomRPManifest.

func (*CustomRPManifest) UnmarshalJSON Uses

func (crm *CustomRPManifest) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CustomRPManifest struct.

type CustomRPManifestProperties Uses

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

CustomRPManifestProperties the manifest for the custom resource provider

type CustomRPResourceTypeRouteDefinition Uses

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

CustomRPResourceTypeRouteDefinition the route definition for a resource implemented by the custom resource provider.

type CustomRPRouteDefinition Uses

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

CustomRPRouteDefinition a route definition that defines an action or resource that can be interacted with through the custom resource provider.

type CustomRPValidations Uses

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

CustomRPValidations a validation to apply on custom resource provider requests.

type CustomResourceProviderClient Uses

type CustomResourceProviderClient struct {
    BaseClient
}

CustomResourceProviderClient is the allows extension of ARM control plane with custom resource providers.

func NewCustomResourceProviderClient Uses

func NewCustomResourceProviderClient(subscriptionID string) CustomResourceProviderClient

NewCustomResourceProviderClient creates an instance of the CustomResourceProviderClient client.

func NewCustomResourceProviderClientWithBaseURI Uses

func NewCustomResourceProviderClientWithBaseURI(baseURI string, subscriptionID string) CustomResourceProviderClient

NewCustomResourceProviderClientWithBaseURI creates an instance of the CustomResourceProviderClient client.

func (CustomResourceProviderClient) CreateOrUpdate Uses

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 (CustomResourceProviderClient) CreateOrUpdatePreparer Uses

func (client CustomResourceProviderClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceProviderName string, resourceProvider CustomRPManifest) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (CustomResourceProviderClient) CreateOrUpdateResponder Uses

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

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 (CustomResourceProviderClient) Delete Uses

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 (CustomResourceProviderClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (CustomResourceProviderClient) DeleteResponder Uses

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 (CustomResourceProviderClient) DeleteSender Uses

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 (CustomResourceProviderClient) Get Uses

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 (CustomResourceProviderClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (CustomResourceProviderClient) GetResponder Uses

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

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 (CustomResourceProviderClient) ListByResourceGroup Uses

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 (CustomResourceProviderClient) ListByResourceGroupComplete Uses

func (client CustomResourceProviderClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ListByCustomRPManifestIterator, err error)

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

func (CustomResourceProviderClient) ListByResourceGroupPreparer Uses

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (CustomResourceProviderClient) ListByResourceGroupResponder Uses

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

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 (CustomResourceProviderClient) ListBySubscription Uses

func (client CustomResourceProviderClient) ListBySubscription(ctx context.Context) (result ListByCustomRPManifestPage, err error)

ListBySubscription gets all the custom resource providers within a subscription.

func (CustomResourceProviderClient) ListBySubscriptionComplete Uses

func (client CustomResourceProviderClient) ListBySubscriptionComplete(ctx context.Context) (result ListByCustomRPManifestIterator, err error)

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

func (CustomResourceProviderClient) ListBySubscriptionPreparer Uses

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

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (CustomResourceProviderClient) ListBySubscriptionResponder Uses

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

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 (CustomResourceProviderClient) Update Uses

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 (CustomResourceProviderClient) UpdatePreparer Uses

func (client CustomResourceProviderClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceProviderName string, patchableResource ResourceProvidersUpdate) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (CustomResourceProviderClient) UpdateResponder Uses

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

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.

type CustomResourceProviderCreateOrUpdateFuture Uses

type CustomResourceProviderCreateOrUpdateFuture struct {
    azure.Future
}

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

func (*CustomResourceProviderCreateOrUpdateFuture) Result Uses

func (future *CustomResourceProviderCreateOrUpdateFuture) Result(client CustomResourceProviderClient) (crm CustomRPManifest, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type CustomResourceProviderDeleteFuture Uses

type CustomResourceProviderDeleteFuture struct {
    azure.Future
}

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

func (*CustomResourceProviderDeleteFuture) Result Uses

func (future *CustomResourceProviderDeleteFuture) Result(client CustomResourceProviderClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ErrorDefinition Uses

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

ErrorDefinition error definition.

type ErrorResponse Uses

type ErrorResponse struct {
    // Error - The error details.
    Error *ErrorDefinition `json:"error,omitempty"`
}

ErrorResponse error response.

type ListByCustomRPManifest Uses

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

ListByCustomRPManifest list of custom resource providers.

func (ListByCustomRPManifest) IsEmpty Uses

func (lbcrm ListByCustomRPManifest) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListByCustomRPManifestIterator Uses

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

ListByCustomRPManifestIterator provides access to a complete listing of CustomRPManifest values.

func NewListByCustomRPManifestIterator Uses

func NewListByCustomRPManifestIterator(page ListByCustomRPManifestPage) ListByCustomRPManifestIterator

Creates a new instance of the ListByCustomRPManifestIterator type.

func (*ListByCustomRPManifestIterator) Next Uses

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 (*ListByCustomRPManifestIterator) NextWithContext Uses

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 (ListByCustomRPManifestIterator) NotDone Uses

func (iter ListByCustomRPManifestIterator) NotDone() bool

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

func (ListByCustomRPManifestIterator) Response Uses

func (iter ListByCustomRPManifestIterator) Response() ListByCustomRPManifest

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

func (ListByCustomRPManifestIterator) Value Uses

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.

type ListByCustomRPManifestPage Uses

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

ListByCustomRPManifestPage contains a page of CustomRPManifest values.

func NewListByCustomRPManifestPage Uses

func NewListByCustomRPManifestPage(getNextPage func(context.Context, ListByCustomRPManifest) (ListByCustomRPManifest, error)) ListByCustomRPManifestPage

Creates a new instance of the ListByCustomRPManifestPage type.

func (*ListByCustomRPManifestPage) Next Uses

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 (*ListByCustomRPManifestPage) NextWithContext Uses

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 (ListByCustomRPManifestPage) NotDone Uses

func (page ListByCustomRPManifestPage) NotDone() bool

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

func (ListByCustomRPManifestPage) Response Uses

func (page ListByCustomRPManifestPage) Response() ListByCustomRPManifest

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

func (ListByCustomRPManifestPage) Values Uses

func (page ListByCustomRPManifestPage) Values() []CustomRPManifest

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

type OperationsClient Uses

type OperationsClient struct {
    BaseClient
}

OperationsClient is the allows extension of ARM control plane with custom resource providers.

func NewOperationsClient Uses

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List Uses

func (client OperationsClient) List(ctx context.Context) (result ResourceProviderOperationListPage, err error)

List the list of operations provided by Microsoft CustomProviders.

func (OperationsClient) ListComplete Uses

func (client OperationsClient) ListComplete(ctx context.Context) (result ResourceProviderOperationListIterator, err error)

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

func (OperationsClient) ListPreparer Uses

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

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 (OperationsClient) ListSender Uses

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.

type ProvisioningState Uses

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

const (
    // Accepted ...
    Accepted ProvisioningState = "Accepted"
    // Deleting ...
    Deleting ProvisioningState = "Deleting"
    // Failed ...
    Failed ProvisioningState = "Failed"
    // Running ...
    Running ProvisioningState = "Running"
    // Succeeded ...
    Succeeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues Uses

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type Resource Uses

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

Resource the resource definition.

func (Resource) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Resource.

type ResourceProviderOperation Uses

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

ResourceProviderOperation supported operations of this resource provider.

type ResourceProviderOperationDisplay Uses

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

ResourceProviderOperationDisplay display metadata associated with the operation.

type ResourceProviderOperationList Uses

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

ResourceProviderOperationList results of the request to list operations.

func (ResourceProviderOperationList) IsEmpty Uses

func (rpol ResourceProviderOperationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ResourceProviderOperationListIterator Uses

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

ResourceProviderOperationListIterator provides access to a complete listing of ResourceProviderOperation values.

func NewResourceProviderOperationListIterator Uses

func NewResourceProviderOperationListIterator(page ResourceProviderOperationListPage) ResourceProviderOperationListIterator

Creates a new instance of the ResourceProviderOperationListIterator type.

func (*ResourceProviderOperationListIterator) Next Uses

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 (*ResourceProviderOperationListIterator) NextWithContext Uses

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 (ResourceProviderOperationListIterator) NotDone Uses

func (iter ResourceProviderOperationListIterator) NotDone() bool

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

func (ResourceProviderOperationListIterator) Response Uses

func (iter ResourceProviderOperationListIterator) Response() ResourceProviderOperationList

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

func (ResourceProviderOperationListIterator) Value Uses

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.

type ResourceProviderOperationListPage Uses

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

ResourceProviderOperationListPage contains a page of ResourceProviderOperation values.

func NewResourceProviderOperationListPage Uses

func NewResourceProviderOperationListPage(getNextPage func(context.Context, ResourceProviderOperationList) (ResourceProviderOperationList, error)) ResourceProviderOperationListPage

Creates a new instance of the ResourceProviderOperationListPage type.

func (*ResourceProviderOperationListPage) Next Uses

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 (*ResourceProviderOperationListPage) NextWithContext Uses

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 (ResourceProviderOperationListPage) NotDone Uses

func (page ResourceProviderOperationListPage) NotDone() bool

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

func (ResourceProviderOperationListPage) Response Uses

func (page ResourceProviderOperationListPage) Response() ResourceProviderOperationList

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

func (ResourceProviderOperationListPage) Values Uses

func (page ResourceProviderOperationListPage) Values() []ResourceProviderOperation

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

type ResourceProvidersUpdate Uses

type ResourceProvidersUpdate struct {
    // Tags - Resource tags
    Tags map[string]*string `json:"tags"`
}

ResourceProvidersUpdate custom resource provider update information.

func (ResourceProvidersUpdate) MarshalJSON Uses

func (rpu ResourceProvidersUpdate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceProvidersUpdate.

type ResourceTypeRouting Uses

type ResourceTypeRouting string

ResourceTypeRouting enumerates the values for resource type routing.

const (
    // ResourceTypeRoutingProxy ...
    ResourceTypeRoutingProxy ResourceTypeRouting = "Proxy"
    // ResourceTypeRoutingProxyCache ...
    ResourceTypeRoutingProxyCache ResourceTypeRouting = "Proxy,Cache"
)

func PossibleResourceTypeRoutingValues Uses

func PossibleResourceTypeRoutingValues() []ResourceTypeRouting

PossibleResourceTypeRoutingValues returns an array of possible values for the ResourceTypeRouting const type.

type ValidationType Uses

type ValidationType string

ValidationType enumerates the values for validation type.

const (
    // Swagger ...
    Swagger ValidationType = "Swagger"
)

func PossibleValidationTypeValues Uses

func PossibleValidationTypeValues() []ValidationType

PossibleValidationTypeValues returns an array of possible values for the ValidationType const type.

Directories

PathSynopsis
customprovidersapi

Package customproviders imports 9 packages (graph) and is imported by 3 packages. Updated 2019-08-05. Refresh now. Tools for package owners.