features

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
• func UserAgent() string
• func Version() string
• type Client
  • func NewClient(subscriptionID string) Client
  • func NewClientWithBaseURI(baseURI string, subscriptionID string) Client
  • func (client Client) Get(resourceProviderNamespace string, featureName string) (result FeatureResult, err error)
  • func (client Client) GetPreparer(resourceProviderNamespace string, featureName string) (*http.Request, error)
  • func (client Client) GetResponder(resp *http.Response) (result FeatureResult, err error)
  • func (client Client) GetSender(req *http.Request) (*http.Response, error)
  • func (client Client) List(resourceProviderNamespace string) (result FeatureOperationsListResult, err error)
  • func (client Client) ListAll() (result FeatureOperationsListResult, err error)
  • func (client Client) ListAllNextResults(lastResults FeatureOperationsListResult) (result FeatureOperationsListResult, err error)
  • func (client Client) ListAllPreparer() (*http.Request, error)
  • func (client Client) ListAllResponder(resp *http.Response) (result FeatureOperationsListResult, err error)
  • func (client Client) ListAllSender(req *http.Request) (*http.Response, error)
  • func (client Client) ListNextResults(lastResults FeatureOperationsListResult) (result FeatureOperationsListResult, err error)
  • func (client Client) ListPreparer(resourceProviderNamespace string) (*http.Request, error)
  • func (client Client) ListResponder(resp *http.Response) (result FeatureOperationsListResult, err error)
  • func (client Client) ListSender(req *http.Request) (*http.Response, error)
  • func (client Client) Register(resourceProviderNamespace string, featureName string) (result FeatureResult, err error)
  • func (client Client) RegisterPreparer(resourceProviderNamespace string, featureName string) (*http.Request, error)
  • func (client Client) RegisterResponder(resp *http.Response) (result FeatureResult, err error)
  • func (client Client) RegisterSender(req *http.Request) (*http.Response, error)
• type FeatureOperationsListResult
  • func (client FeatureOperationsListResult) FeatureOperationsListResultPreparer() (*http.Request, error)
• type FeatureProperties
• type FeatureResult
• type ManagementClient
  • func New(subscriptionID string) ManagementClient
  • func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

Constants

const (
	// APIVersion is the version of the Features
	APIVersion = "2015-12-01"

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

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 Client

type Client struct {
	ManagementClient
}

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.

func (Client) Get

func (client Client) Get(resourceProviderNamespace string, featureName string) (result FeatureResult, err error)

Get gets the preview feature with the specified name.

resourceProviderNamespace is the resource provider namespace for the feature. featureName is the name of the feature to get.

func (Client) GetPreparer

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

GetPreparer prepares the Get request.

func (Client) GetResponder

func (client Client) GetResponder(resp *http.Response) (result FeatureResult, 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(resourceProviderNamespace string) (result FeatureOperationsListResult, err error)

List gets all the preview features in a provider namespace that are available through AFEC for the subscription.

resourceProviderNamespace is the namespace of the resource provider for getting features.

func (Client) ListAll

func (client Client) ListAll() (result FeatureOperationsListResult, err error)

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

func (Client) ListAllNextResults

func (client Client) ListAllNextResults(lastResults FeatureOperationsListResult) (result FeatureOperationsListResult, err error)

ListAllNextResults retrieves the next set of results, if any.

func (Client) ListAllPreparer

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

ListAllPreparer prepares the ListAll request.

func (Client) ListAllResponder

func (client Client) ListAllResponder(resp *http.Response) (result FeatureOperationsListResult, 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) ListNextResults

func (client Client) ListNextResults(lastResults FeatureOperationsListResult) (result FeatureOperationsListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (Client) ListPreparer

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

ListPreparer prepares the List request.

func (Client) ListResponder

func (client Client) ListResponder(resp *http.Response) (result FeatureOperationsListResult, 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(resourceProviderNamespace string, featureName string) (result FeatureResult, err error)

Register registers the preview feature for the subscription.

resourceProviderNamespace is the namespace of the resource provider. featureName is the name of the feature to register.

func (Client) RegisterPreparer

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

RegisterPreparer prepares the Register request.

func (Client) RegisterResponder

func (client Client) RegisterResponder(resp *http.Response) (result FeatureResult, 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 FeatureOperationsListResult

type FeatureOperationsListResult struct {
	autorest.Response `json:"-"`
	Value             *[]FeatureResult `json:"value,omitempty"`
	NextLink          *string          `json:"nextLink,omitempty"`
}

FeatureOperationsListResult is list of previewed features.

func (FeatureOperationsListResult) FeatureOperationsListResultPreparer

func (client FeatureOperationsListResult) FeatureOperationsListResultPreparer() (*http.Request, error)

FeatureOperationsListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type FeatureProperties

type FeatureProperties struct {
	State *string `json:"state,omitempty"`
}

FeatureProperties is information about feature.

type FeatureResult

type FeatureResult struct {
	autorest.Response `json:"-"`
	Name              *string            `json:"name,omitempty"`
	Properties        *FeatureProperties `json:"properties,omitempty"`
	ID                *string            `json:"id,omitempty"`
	Type              *string            `json:"type,omitempty"`
}

FeatureResult is previewed feature information.

type ManagementClient

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	APIVersion     string
	SubscriptionID string
}

ManagementClient is the base client for Features.

func New

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.