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
- func UserAgent() string
- func Version() string
- type BaseClient
- type Client
- func (client Client) Get(ctx context.Context, subscriptionID string) (result Subscription, err error)
- func (client Client) GetPreparer(ctx context.Context, 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(ctx context.Context) (result ListResultPage, err error)
- func (client Client) ListComplete(ctx context.Context) (result ListResultIterator, err error)
- func (client Client) ListLocations(ctx context.Context, subscriptionID string) (result LocationListResult, err error)
- func (client Client) ListLocationsPreparer(ctx context.Context, 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) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client Client) ListResponder(resp *http.Response) (result ListResult, err error)
- func (client Client) ListSender(req *http.Request) (*http.Response, error)
- type ListResult
- type ListResultIterator
- type ListResultPage
- type Location
- type LocationListResult
- type Policies
- type SpendingLimit
- type State
- type Subscription
- type TenantIDDescription
- type TenantListResult
- type TenantListResultIterator
- type TenantListResultPage
- type TenantsClient
- func (client TenantsClient) List(ctx context.Context) (result TenantListResultPage, err error)
- func (client TenantsClient) ListComplete(ctx context.Context) (result TenantListResultIterator, err error)
- func (client TenantsClient) ListPreparer(ctx context.Context) (*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 (
// 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 BaseClient ¶
BaseClient is the base client for Subscriptions.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client.
type Client ¶
type Client struct {
BaseClient
}
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 NewClientWithBaseURI ¶
NewClientWithBaseURI creates an instance of the Client client.
func (Client) Get ¶
func (client Client) Get(ctx context.Context, subscriptionID string) (result Subscription, err error)
Get gets details about a specified subscription.
subscriptionID is the ID of the target subscription.
func (Client) GetPreparer ¶
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 ¶
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(ctx context.Context) (result ListResultPage, err error)
List gets all subscriptions for a tenant.
func (Client) ListComplete ¶
func (client Client) ListComplete(ctx context.Context) (result ListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (Client) ListLocations ¶
func (client Client) ListLocations(ctx context.Context, 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(ctx context.Context, 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 ¶
ListLocationsSender sends the ListLocations request. The method will close the http.Response Body if it receives an error.
func (Client) ListPreparer ¶
ListPreparer prepares the List request.
func (Client) ListResponder ¶
func (client Client) ListResponder(resp *http.Response) (result ListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
type ListResult ¶
type ListResult struct { autorest.Response `json:"-"` // Value - An array of subscriptions. Value *[]Subscription `json:"value,omitempty"` // NextLink - The URL to get the next set of results. NextLink *string `json:"nextLink,omitempty"` }
ListResult subscription list operation response.
func (ListResult) IsEmpty ¶
func (lr ListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ListResultIterator ¶
type ListResultIterator struct {
// contains filtered or unexported fields
}
ListResultIterator provides access to a complete listing of Subscription values.
func (*ListResultIterator) Next ¶
func (iter *ListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (ListResultIterator) NotDone ¶
func (iter ListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (ListResultIterator) Response ¶
func (iter ListResultIterator) Response() ListResult
Response returns the raw server response from the last page request.
func (ListResultIterator) Value ¶
func (iter ListResultIterator) Value() Subscription
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ListResultPage ¶
type ListResultPage struct {
// contains filtered or unexported fields
}
ListResultPage contains a page of Subscription values.
func (*ListResultPage) Next ¶
func (page *ListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (ListResultPage) NotDone ¶
func (page ListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (ListResultPage) Response ¶
func (page ListResultPage) Response() ListResult
Response returns the raw server response from the last page request.
func (ListResultPage) Values ¶
func (page ListResultPage) Values() []Subscription
Values returns the slice of values for the current page or nil if there are no values.
type Location ¶
type Location struct { // ID - The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus. ID *string `json:"id,omitempty"` // SubscriptionID - The subscription ID. SubscriptionID *string `json:"subscriptionId,omitempty"` // Name - The location name. Name *string `json:"name,omitempty"` // DisplayName - The display name of the location. DisplayName *string `json:"displayName,omitempty"` // Latitude - The latitude of the location. Latitude *string `json:"latitude,omitempty"` // Longitude - The longitude of the location. Longitude *string `json:"longitude,omitempty"` }
Location location information.
type LocationListResult ¶
type LocationListResult struct { autorest.Response `json:"-"` // Value - An array of locations. Value *[]Location `json:"value,omitempty"` }
LocationListResult location list operation response.
type Policies ¶
type Policies struct { // LocationPlacementID - The subscription location placement ID. The ID indicates which regions are visible for a subscription. For example, a subscription with a location placement Id of Public_2014-09-01 has access to Azure public regions. LocationPlacementID *string `json:"locationPlacementId,omitempty"` // QuotaID - The subscription quota ID. QuotaID *string `json:"quotaId,omitempty"` // SpendingLimit - The subscription spending limit. Possible values include: 'On', 'Off', 'CurrentPeriodOff' SpendingLimit SpendingLimit `json:"spendingLimit,omitempty"` }
Policies subscription policies.
type SpendingLimit ¶
type SpendingLimit string
SpendingLimit enumerates the values for spending limit.
const ( // CurrentPeriodOff ... CurrentPeriodOff SpendingLimit = "CurrentPeriodOff" // Off ... Off SpendingLimit = "Off" // On ... On SpendingLimit = "On" )
type Subscription ¶
type Subscription struct { autorest.Response `json:"-"` // ID - The fully qualified ID for the subscription. For example, /subscriptions/00000000-0000-0000-0000-000000000000. ID *string `json:"id,omitempty"` // SubscriptionID - The subscription ID. SubscriptionID *string `json:"subscriptionId,omitempty"` // DisplayName - The subscription display name. DisplayName *string `json:"displayName,omitempty"` // State - The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted. Possible values include: 'Enabled', 'Warned', 'PastDue', 'Disabled', 'Deleted' State State `json:"state,omitempty"` // SubscriptionPolicies - The subscription policies. SubscriptionPolicies *Policies `json:"subscriptionPolicies,omitempty"` // AuthorizationSource - The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'. AuthorizationSource *string `json:"authorizationSource,omitempty"` }
Subscription subscription information.
type TenantIDDescription ¶
type TenantIDDescription struct { // ID - The fully qualified ID of the tenant. For example, /tenants/00000000-0000-0000-0000-000000000000. ID *string `json:"id,omitempty"` // TenantID - The tenant ID. For example, 00000000-0000-0000-0000-000000000000. TenantID *string `json:"tenantId,omitempty"` }
TenantIDDescription tenant Id information.
type TenantListResult ¶
type TenantListResult struct { autorest.Response `json:"-"` // Value - An array of tenants. Value *[]TenantIDDescription `json:"value,omitempty"` // NextLink - The URL to use for getting the next set of results. NextLink *string `json:"nextLink,omitempty"` }
TenantListResult tenant Ids information.
func (TenantListResult) IsEmpty ¶
func (tlr TenantListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type TenantListResultIterator ¶
type TenantListResultIterator struct {
// contains filtered or unexported fields
}
TenantListResultIterator provides access to a complete listing of TenantIDDescription values.
func (*TenantListResultIterator) Next ¶
func (iter *TenantListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (TenantListResultIterator) NotDone ¶
func (iter TenantListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (TenantListResultIterator) Response ¶
func (iter TenantListResultIterator) Response() TenantListResult
Response returns the raw server response from the last page request.
func (TenantListResultIterator) Value ¶
func (iter TenantListResultIterator) Value() TenantIDDescription
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type TenantListResultPage ¶
type TenantListResultPage struct {
// contains filtered or unexported fields
}
TenantListResultPage contains a page of TenantIDDescription values.
func (*TenantListResultPage) Next ¶
func (page *TenantListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (TenantListResultPage) NotDone ¶
func (page TenantListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (TenantListResultPage) Response ¶
func (page TenantListResultPage) Response() TenantListResult
Response returns the raw server response from the last page request.
func (TenantListResultPage) Values ¶
func (page TenantListResultPage) Values() []TenantIDDescription
Values returns the slice of values for the current page or nil if there are no values.
type TenantsClient ¶
type TenantsClient struct {
BaseClient
}
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(ctx context.Context) (result TenantListResultPage, err error)
List gets the tenants for your account.
func (TenantsClient) ListComplete ¶
func (client TenantsClient) ListComplete(ctx context.Context) (result TenantListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (TenantsClient) ListPreparer ¶
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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.