subscriptions

package
v11.0.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Sep 28, 2017 License: Apache-2.0 Imports: 4 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 (
	// 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 GroupClient 

type GroupClient struct {
	ManagementClient
}

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

func NewGroupClient() GroupClient

NewGroupClient creates an instance of the GroupClient client.

func NewGroupClientWithBaseURI 

func NewGroupClientWithBaseURI(baseURI string) GroupClient

NewGroupClientWithBaseURI creates an instance of the GroupClient client.

func (GroupClient) Get 

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

Get gets details about a specified subscription.

subscriptionID is the ID of the target subscription.

func (GroupClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (GroupClient) GetResponder 

func (client GroupClient) 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 (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() (result ListResult, err error)

List gets all subscriptions for a tenant.

func (GroupClient) ListComplete 

func (client GroupClient) ListComplete(cancel <-chan struct{}) (<-chan Subscription, <-chan error)

ListComplete gets all elements from the list without paging.

func (GroupClient) ListLocations 

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

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

ListLocationsPreparer prepares the ListLocations request.

func (GroupClient) ListLocationsResponder 

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

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

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

ListNextResults retrieves the next set of results, if any.

func (GroupClient) ListPreparer 

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

ListPreparer prepares the List request.

func (GroupClient) ListResponder 

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

type ListResult 

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

ListResult is subscription list operation response.

func (ListResult) ListResultPreparer 

func (client ListResult) ListResultPreparer() (*http.Request, error)

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

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
}

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 Policies 

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

Policies is subscription policies.

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"`
	DisplayName          *string   `json:"displayName,omitempty"`
	State                State     `json:"state,omitempty"`
	SubscriptionPolicies *Policies `json:"subscriptionPolicies,omitempty"`
	AuthorizationSource  *string   `json:"authorizationSource,omitempty"`
}

Subscription is subscription information.

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

func (client TenantsClient) ListComplete(cancel <-chan struct{}) (<-chan TenantIDDescription, <-chan error)

ListComplete gets all elements from the list without paging.

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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.