subscriptions

Documentation

Overview

Package subscriptions implements the Azure ARM Subscriptions service API version 2015-11-01.

Index

• Constants
• func UserAgent() string
• func Version() string
• type Client
  • func NewClient() Client
  • func NewClientWithBaseURI(baseURI string) Client
  • func (client Client) Get(subscriptionID string) (result Subscription, err error)
  • func (client Client) GetPreparer(subscriptionID string) (*http.Request, error)
  • func (client Client) GetResponder(resp *http.Response) (result Subscription, err error)
  • func (client Client) GetSender(req *http.Request) (*http.Response, error)
  • func (client Client) List() (result SubscriptionListResult, err error)
  • func (client Client) ListLocations(subscriptionID string) (result LocationListResult, err error)
  • func (client Client) ListLocationsPreparer(subscriptionID string) (*http.Request, error)
  • func (client Client) ListLocationsResponder(resp *http.Response) (result LocationListResult, err error)
  • func (client Client) ListLocationsSender(req *http.Request) (*http.Response, error)
  • func (client Client) ListNextResults(lastResults SubscriptionListResult) (result SubscriptionListResult, err error)
  • func (client Client) ListPreparer() (*http.Request, error)
  • func (client Client) ListResponder(resp *http.Response) (result SubscriptionListResult, err error)
  • func (client Client) ListSender(req *http.Request) (*http.Response, error)
• type Location
• type LocationListResult
• type ManagementClient
  • func New() ManagementClient
  • func NewWithBaseURI(baseURI string) ManagementClient
• type Subscription
• type SubscriptionListResult
  • func (client SubscriptionListResult) SubscriptionListResultPreparer() (*http.Request, error)
• type SubscriptionPolicies
• type TenantIDDescription
• type TenantListResult
  • func (client TenantListResult) TenantListResultPreparer() (*http.Request, error)
• type TenantsClient
  • func NewTenantsClient() TenantsClient
  • func NewTenantsClientWithBaseURI(baseURI string) TenantsClient
  • func (client TenantsClient) List() (result TenantListResult, err error)
  • func (client TenantsClient) ListNextResults(lastResults TenantListResult) (result TenantListResult, err error)
  • func (client TenantsClient) ListPreparer() (*http.Request, error)
  • func (client TenantsClient) ListResponder(resp *http.Response) (result TenantListResult, err error)
  • func (client TenantsClient) ListSender(req *http.Request) (*http.Response, error)

Constants

const (
	// APIVersion is the version of the Subscriptions
	APIVersion = "2015-11-01"

	// DefaultBaseURI is the default URI used for the service Subscriptions
	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 client for the Subscriptions methods of the Subscriptions service.

func NewClient

func NewClient() Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI

func NewClientWithBaseURI(baseURI string) Client

NewClientWithBaseURI creates an instance of the Client client.

func (Client) Get

func (client Client) Get(subscriptionID string) (result Subscription, err error)

Get gets details about particular subscription.

subscriptionID is id of the subscription.

func (Client) GetPreparer

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

GetPreparer prepares the Get request.

func (Client) GetResponder

func (client Client) GetResponder(resp *http.Response) (result Subscription, 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() (result SubscriptionListResult, err error)

List gets a list of the subscriptionIds.

func (Client) ListLocations

func (client Client) ListLocations(subscriptionID string) (result LocationListResult, err error)

ListLocations gets a list of the subscription locations.

subscriptionID is id of the subscription

func (Client) ListLocationsPreparer

func (client Client) ListLocationsPreparer(subscriptionID string) (*http.Request, error)

ListLocationsPreparer prepares the ListLocations request.

func (Client) ListLocationsResponder

func (client Client) ListLocationsResponder(resp *http.Response) (result LocationListResult, err error)

ListLocationsResponder handles the response to the ListLocations request. The method always closes the http.Response Body.

func (Client) ListLocationsSender

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

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

func (Client) ListNextResults

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

ListNextResults retrieves the next set of results, if any.

func (Client) ListPreparer

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

ListPreparer prepares the List request.

func (Client) ListResponder

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

type Location

type Location struct {
	ID             *string `json:"id,omitempty"`
	SubscriptionID *string `json:"subscriptionId,omitempty"`
	Name           *string `json:"name,omitempty"`
	DisplayName    *string `json:"displayName,omitempty"`
	Latitude       *string `json:"latitude,omitempty"`
	Longitude      *string `json:"longitude,omitempty"`
}

Location is location information.

type LocationListResult

type LocationListResult struct {
	autorest.Response `json:"-"`
	Value             *[]Location `json:"value,omitempty"`
}

LocationListResult is location list operation response.

type ManagementClient

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

ManagementClient is the base client for Subscriptions.

func New

func New() ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type Subscription

type Subscription struct {
	autorest.Response    `json:"-"`
	ID                   *string               `json:"id,omitempty"`
	SubscriptionID       *string               `json:"subscriptionId,omitempty"`
	DisplayName          *string               `json:"displayName,omitempty"`
	State                *string               `json:"state,omitempty"`
	SubscriptionPolicies *SubscriptionPolicies `json:"subscriptionPolicies,omitempty"`
}

Subscription is subscription information.

type SubscriptionListResult

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

SubscriptionListResult is subscription list operation response.

func (SubscriptionListResult) SubscriptionListResultPreparer

func (client SubscriptionListResult) SubscriptionListResultPreparer() (*http.Request, error)

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

type SubscriptionPolicies

type SubscriptionPolicies struct {
	LocationPlacementID *string `json:"locationPlacementId,omitempty"`
	QuotaID             *string `json:"quotaId,omitempty"`
}

SubscriptionPolicies is subscription policies.

type TenantIDDescription

type TenantIDDescription struct {
	ID       *string `json:"id,omitempty"`
	TenantID *string `json:"tenantId,omitempty"`
}

TenantIDDescription is tenant Id information

type TenantListResult

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

TenantListResult is tenant Ids information.

func (TenantListResult) TenantListResultPreparer

func (client TenantListResult) TenantListResultPreparer() (*http.Request, error)

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

type TenantsClient

type TenantsClient struct {
	ManagementClient
}

TenantsClient is the client for the Tenants methods of the Subscriptions service.

func NewTenantsClient

func NewTenantsClient() TenantsClient

NewTenantsClient creates an instance of the TenantsClient client.

func NewTenantsClientWithBaseURI

func NewTenantsClientWithBaseURI(baseURI string) TenantsClient

NewTenantsClientWithBaseURI creates an instance of the TenantsClient client.

func (TenantsClient) List

func (client TenantsClient) List() (result TenantListResult, err error)

List gets a list of the tenantIds.

func (TenantsClient) ListNextResults

func (client TenantsClient) ListNextResults(lastResults TenantListResult) (result TenantListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (TenantsClient) ListPreparer

func (client TenantsClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (TenantsClient) ListResponder

func (client TenantsClient) ListResponder(resp *http.Response) (result TenantListResult, err error)

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

func (TenantsClient) ListSender

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