subscriptions

package
v8.1.0-beta+incompatible Latest Latest
Warning

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

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

Documentation

Overview

Package subscriptions implements the Azure ARM Subscriptions service API version 2016-06-01.

All resource groups and resources exist within subscriptions. These operation enable you get information about your subscriptions and tenants. A tenant is a dedicated instance of Azure Active Directory (Azure AD) for your organization.

Index

Constants

View Source
const (
	// APIVersion is the version of the Subscriptions
	APIVersion = "2016-06-01"

	// DefaultBaseURI is the default URI used for the service Subscriptions
	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 Client

type Client struct {
	ManagementClient
}

Client is the all resource groups and resources exist within subscriptions. These operation enable you get information about your subscriptions and tenants. A tenant is a dedicated instance of Azure Active Directory (Azure AD) for your organization.

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 a specified subscription.

subscriptionID is the ID of the target 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 all subscriptions for a tenant.

func (Client) ListLocations

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

ListLocations this operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.

subscriptionID is the ID of the target 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 SpendingLimit

type SpendingLimit string

SpendingLimit enumerates the values for spending limit.

const (
	// CurrentPeriodOff specifies the current period off state for spending
	// limit.
	CurrentPeriodOff SpendingLimit = "CurrentPeriodOff"
	// Off specifies the off state for spending limit.
	Off SpendingLimit = "Off"
	// On specifies the on state for spending limit.
	On SpendingLimit = "On"
)

type State

type State string

State enumerates the values for state.

const (
	// Deleted specifies the deleted state for state.
	Deleted State = "Deleted"
	// Disabled specifies the disabled state for state.
	Disabled State = "Disabled"
	// Enabled specifies the enabled state for state.
	Enabled State = "Enabled"
	// PastDue specifies the past due state for state.
	PastDue State = "PastDue"
	// Warned specifies the warned state for state.
	Warned State = "Warned"
)

type Subscription

type Subscription struct {
	autorest.Response    `json:"-"`
	ID                   *string               `json:"id,omitempty"`
	SubscriptionID       *string               `json:"subscriptionId,omitempty"`
	TenantID             *string               `json:"tenantId,omitempty"`
	DisplayName          *string               `json:"displayName,omitempty"`
	State                State                 `json:"state,omitempty"`
	SubscriptionPolicies *SubscriptionPolicies `json:"subscriptionPolicies,omitempty"`
	AuthorizationSource  *string               `json:"authorizationSource,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"`
	SpendingLimit       SpendingLimit `json:"spendingLimit,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 all resource groups and resources exist within subscriptions. These operation enable you get information about your subscriptions and tenants. A tenant is a dedicated instance of Azure Active Directory (Azure AD) for your organization.

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 the tenants for your account.

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.

Jump to

Keyboard shortcuts

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