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 GroupClient
  • func NewGroupClient(subscriptionID string) GroupClient
  • func NewGroupClientWithBaseURI(baseURI string, subscriptionID string) GroupClient
  • func (client GroupClient) Get(resourceProviderNamespace string, featureName string) (result Result, err error)
  • func (client GroupClient) GetPreparer(resourceProviderNamespace string, featureName string) (*http.Request, error)
  • func (client GroupClient) GetResponder(resp *http.Response) (result Result, err error)
  • func (client GroupClient) GetSender(req *http.Request) (*http.Response, error)
  • func (client GroupClient) List(resourceProviderNamespace string) (result OperationsListResult, err error)
  • func (client GroupClient) ListAll() (result OperationsListResult, err error)
  • func (client GroupClient) ListAllComplete(cancel <-chan struct{}) (<-chan Result, <-chan error)
  • func (client GroupClient) ListAllNextResults(lastResults OperationsListResult) (result OperationsListResult, err error)
  • func (client GroupClient) ListAllPreparer() (*http.Request, error)
  • func (client GroupClient) ListAllResponder(resp *http.Response) (result OperationsListResult, err error)
  • func (client GroupClient) ListAllSender(req *http.Request) (*http.Response, error)
  • func (client GroupClient) ListComplete(resourceProviderNamespace string, cancel <-chan struct{}) (<-chan Result, <-chan error)
  • func (client GroupClient) ListNextResults(lastResults OperationsListResult) (result OperationsListResult, err error)
  • func (client GroupClient) ListPreparer(resourceProviderNamespace string) (*http.Request, error)
  • func (client GroupClient) ListResponder(resp *http.Response) (result OperationsListResult, err error)
  • func (client GroupClient) ListSender(req *http.Request) (*http.Response, error)
  • func (client GroupClient) Register(resourceProviderNamespace string, featureName string) (result Result, err error)
  • func (client GroupClient) RegisterPreparer(resourceProviderNamespace string, featureName string) (*http.Request, error)
  • func (client GroupClient) RegisterResponder(resp *http.Response) (result Result, err error)
  • func (client GroupClient) RegisterSender(req *http.Request) (*http.Response, error)
• type ManagementClient
  • func New(subscriptionID string) ManagementClient
  • func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient
• type OperationsListResult
  • func (client OperationsListResult) OperationsListResultPreparer() (*http.Request, error)
• type Properties
• type Result

Constants

const (
	// 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 GroupClient

type GroupClient struct {
	ManagementClient
}

GroupClient 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 NewGroupClient

func NewGroupClient(subscriptionID string) GroupClient

NewGroupClient creates an instance of the GroupClient client.

func NewGroupClientWithBaseURI

func NewGroupClientWithBaseURI(baseURI string, subscriptionID string) GroupClient

NewGroupClientWithBaseURI creates an instance of the GroupClient client.

func (GroupClient) Get

func (client GroupClient) Get(resourceProviderNamespace string, featureName string) (result Result, 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 (GroupClient) GetPreparer

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

GetPreparer prepares the Get request.

func (GroupClient) GetResponder

func (client GroupClient) 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 (GroupClient) GetSender

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

func (client GroupClient) List(resourceProviderNamespace string) (result OperationsListResult, 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 (GroupClient) ListAll

func (client GroupClient) ListAll() (result OperationsListResult, err error)

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

func (GroupClient) ListAllComplete

func (client GroupClient) ListAllComplete(cancel <-chan struct{}) (<-chan Result, <-chan error)

ListAllComplete gets all elements from the list without paging.

func (GroupClient) ListAllNextResults

func (client GroupClient) ListAllNextResults(lastResults OperationsListResult) (result OperationsListResult, err error)

ListAllNextResults retrieves the next set of results, if any.

func (GroupClient) ListAllPreparer

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

ListAllPreparer prepares the ListAll request.

func (GroupClient) ListAllResponder

func (client GroupClient) 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 (GroupClient) ListAllSender

func (client GroupClient) 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 (GroupClient) ListComplete

func (client GroupClient) ListComplete(resourceProviderNamespace string, cancel <-chan struct{}) (<-chan Result, <-chan error)

ListComplete gets all elements from the list without paging.

func (GroupClient) ListNextResults

func (client GroupClient) ListNextResults(lastResults OperationsListResult) (result OperationsListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (GroupClient) ListPreparer

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

ListPreparer prepares the List request.

func (GroupClient) ListResponder

func (client GroupClient) 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 (GroupClient) ListSender

func (client GroupClient) 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 (GroupClient) Register

func (client GroupClient) Register(resourceProviderNamespace string, featureName string) (result Result, 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 (GroupClient) RegisterPreparer

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

RegisterPreparer prepares the Register request.

func (GroupClient) RegisterResponder

func (client GroupClient) 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 (GroupClient) RegisterSender

func (client GroupClient) 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 ManagementClient

type ManagementClient struct {
	autorest.Client
	BaseURI        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.

type OperationsListResult

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

OperationsListResult is list of previewed features.

func (OperationsListResult) OperationsListResultPreparer

func (client OperationsListResult) OperationsListResultPreparer() (*http.Request, error)

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

type Properties

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

Properties is information about feature.

type Result

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

Result is previewed feature information.