features

package
v40.2.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Mar 6, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package features implements the Azure ARM Features service API version 2015-12-01.

Azure Feature Exposure Control (AFEC) provides a mechanism for the resource providers to control feature exposure to users. Resource providers typically use this mechanism to provide public/private preview for new features prior to making them generally available. Users need to explicitly register for AFEC features to get access to such functionality.

Index

Constants

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

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

BaseClient is the base client for Features.

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

func (BaseClient) ListOperations

func (client BaseClient) ListOperations(ctx context.Context) (result OperationListResultPage, err error)

ListOperations lists all of the available Microsoft.Features REST API operations.

func (BaseClient) ListOperationsComplete

func (client BaseClient) ListOperationsComplete(ctx context.Context) (result OperationListResultIterator, err error)

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

func (BaseClient) ListOperationsPreparer

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

ListOperationsPreparer prepares the ListOperations request.

func (BaseClient) ListOperationsResponder

func (client BaseClient) ListOperationsResponder(resp *http.Response) (result OperationListResult, err error)

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

func (BaseClient) ListOperationsSender

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

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

type Client

type Client struct {
	BaseClient
}

Client is the azure Feature Exposure Control (AFEC) provides a mechanism for the resource providers to control feature exposure to users. Resource providers typically use this mechanism to provide public/private preview for new features prior to making them generally available. Users need to explicitly register for AFEC features to get access to such functionality.

func NewClient

func NewClient(subscriptionID string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI

func NewClientWithBaseURI(baseURI string, subscriptionID string) Client

NewClientWithBaseURI creates an instance of the Client client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (Client) Get

func (client Client) Get(ctx context.Context, resourceProviderNamespace string, featureName string) (result Result, err error)

Get gets the preview feature with the specified name. Parameters: resourceProviderNamespace - the resource provider namespace for the feature. featureName - the name of the feature to get.

func (Client) GetPreparer

func (client Client) GetPreparer(ctx context.Context, resourceProviderNamespace string, featureName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (Client) GetResponder

func (client Client) GetResponder(resp *http.Response) (result Result, err error)

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

func (Client) GetSender

func (client Client) 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) List

func (client Client) List(ctx context.Context, resourceProviderNamespace string) (result OperationsListResultPage, err error)

List gets all the preview features in a provider namespace that are available through AFEC for the subscription. Parameters: resourceProviderNamespace - the namespace of the resource provider for getting features.

func (Client) ListAll

func (client Client) ListAll(ctx context.Context) (result OperationsListResultPage, err error)

ListAll gets all the preview features that are available through AFEC for the subscription.

func (Client) ListAllComplete

func (client Client) ListAllComplete(ctx context.Context) (result OperationsListResultIterator, err error)

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

func (Client) ListAllPreparer

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

ListAllPreparer prepares the ListAll request.

func (Client) ListAllResponder

func (client Client) ListAllResponder(resp *http.Response) (result OperationsListResult, err error)

ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.

func (Client) ListAllSender

func (client Client) 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.

func (Client) ListComplete

func (client Client) ListComplete(ctx context.Context, resourceProviderNamespace string) (result OperationsListResultIterator, err error)

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

func (Client) ListPreparer

func (client Client) ListPreparer(ctx context.Context, resourceProviderNamespace string) (*http.Request, error)

ListPreparer prepares the List request.

func (Client) ListResponder

func (client Client) ListResponder(resp *http.Response) (result OperationsListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (Client) ListSender

func (client Client) 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.

func (Client) Register

func (client Client) Register(ctx context.Context, resourceProviderNamespace string, featureName string) (result Result, err error)

Register registers the preview feature for the subscription. Parameters: resourceProviderNamespace - the namespace of the resource provider. featureName - the name of the feature to register.

func (Client) RegisterPreparer

func (client Client) RegisterPreparer(ctx context.Context, resourceProviderNamespace string, featureName string) (*http.Request, error)

RegisterPreparer prepares the Register request.

func (Client) RegisterResponder

func (client Client) RegisterResponder(resp *http.Response) (result Result, err error)

RegisterResponder handles the response to the Register request. The method always closes the http.Response Body.

func (Client) RegisterSender

func (client Client) RegisterSender(req *http.Request) (*http.Response, error)

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

type Operation

type Operation struct {
	// Name - Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
	// Display - The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation microsoft.Features operation

type OperationDisplay

type OperationDisplay struct {
	// Provider - Service provider: Microsoft.Features
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed: Profile, endpoint, etc.
	Resource *string `json:"resource,omitempty"`
	// Operation - Operation type: Read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`
}

OperationDisplay the object that represents the operation.

type OperationListResult

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - List of Microsoft.Features operations.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult result of the request to list Microsoft.Features operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) IsEmpty

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next

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

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

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response

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

func (OperationListResultIterator) Value

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

type OperationListResultPage

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage

func NewOperationListResultPage(getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next

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

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

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response

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

func (OperationListResultPage) Values

func (page OperationListResultPage) Values() []Operation

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

type OperationsListResult

type OperationsListResult struct {
	autorest.Response `json:"-"`
	// Value - The array of features.
	Value *[]Result `json:"value,omitempty"`
	// NextLink - The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationsListResult list of previewed features.

func (OperationsListResult) IsEmpty

func (olr OperationsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationsListResultIterator

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

OperationsListResultIterator provides access to a complete listing of Result values.

func NewOperationsListResultIterator

func NewOperationsListResultIterator(page OperationsListResultPage) OperationsListResultIterator

Creates a new instance of the OperationsListResultIterator type.

func (*OperationsListResultIterator) Next

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

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

func (iter OperationsListResultIterator) NotDone() bool

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

func (OperationsListResultIterator) Response

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

func (OperationsListResultIterator) Value

func (iter OperationsListResultIterator) Value() Result

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

type OperationsListResultPage

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

OperationsListResultPage contains a page of Result values.

func NewOperationsListResultPage

func NewOperationsListResultPage(getNextPage func(context.Context, OperationsListResult) (OperationsListResult, error)) OperationsListResultPage

Creates a new instance of the OperationsListResultPage type.

func (*OperationsListResultPage) Next

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

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

func (page OperationsListResultPage) NotDone() bool

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

func (OperationsListResultPage) Response

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

func (OperationsListResultPage) Values

func (page OperationsListResultPage) Values() []Result

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

type Properties

type Properties struct {
	// State - The registration state of the feature for the subscription.
	State *string `json:"state,omitempty"`
}

Properties information about feature.

type Result

type Result struct {
	autorest.Response `json:"-"`
	// Name - The name of the feature.
	Name *string `json:"name,omitempty"`
	// Properties - Properties of the previewed feature.
	Properties *Properties `json:"properties,omitempty"`
	// ID - The resource ID of the feature.
	ID *string `json:"id,omitempty"`
	// Type - The resource type of the feature.
	Type *string `json:"type,omitempty"`
}

Result previewed feature information.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL