azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/resources/mgmt/2019-06-01/subscriptions Index | Files | Directories

package subscriptions

import "github.com/Azure/azure-sdk-for-go/services/resources/mgmt/2019-06-01/subscriptions"

Package subscriptions implements the Azure ARM Subscriptions service API version 2019-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

Package Files

client.go models.go operations.go subscriptions.go tenants.go version.go

Constants

const (
    // DefaultBaseURI is the default URI used for the service Subscriptions
    DefaultBaseURI = "https://management.azure.com"
)

func UserAgent Uses

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version Uses

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

type BaseClient Uses

type BaseClient struct {
    autorest.Client
    BaseURI string
}

BaseClient is the base client for Subscriptions.

func New Uses

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type Client Uses

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 NewClient Uses

func NewClient() Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI Uses

func NewClientWithBaseURI(baseURI string) Client

NewClientWithBaseURI creates an instance of the Client client.

func (Client) Get Uses

func (client Client) Get(ctx context.Context, subscriptionID string) (result Subscription, err error)

Get gets details about a specified subscription. Parameters: subscriptionID - the ID of the target subscription.

func (Client) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (Client) GetResponder Uses

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 Uses

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 Uses

func (client Client) List(ctx context.Context) (result ListResultPage, err error)

List gets all subscriptions for a tenant.

func (Client) ListComplete Uses

func (client Client) ListComplete(ctx context.Context) (result ListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListLocations Uses

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. Parameters: subscriptionID - the ID of the target subscription.

func (Client) ListLocationsPreparer Uses

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

ListLocationsPreparer prepares the ListLocations request.

func (Client) ListLocationsResponder Uses

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 Uses

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) ListPreparer Uses

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

ListPreparer prepares the List request.

func (Client) ListResponder Uses

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.

func (Client) ListSender Uses

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 ListResult Uses

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 Uses

func (lr ListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListResultIterator Uses

type ListResultIterator struct {
    // contains filtered or unexported fields
}

ListResultIterator provides access to a complete listing of Subscription values.

func NewListResultIterator Uses

func NewListResultIterator(page ListResultPage) ListResultIterator

Creates a new instance of the ListResultIterator type.

func (*ListResultIterator) Next Uses

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. Deprecated: Use NextWithContext() instead.

func (*ListResultIterator) NextWithContext Uses

func (iter *ListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 Uses

func (iter ListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ListResultIterator) Response Uses

func (iter ListResultIterator) Response() ListResult

Response returns the raw server response from the last page request.

func (ListResultIterator) Value Uses

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 Uses

type ListResultPage struct {
    // contains filtered or unexported fields
}

ListResultPage contains a page of Subscription values.

func NewListResultPage Uses

func NewListResultPage(getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage

Creates a new instance of the ListResultPage type.

func (*ListResultPage) Next Uses

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. Deprecated: Use NextWithContext() instead.

func (*ListResultPage) NextWithContext Uses

func (page *ListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 Uses

func (page ListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ListResultPage) Response Uses

func (page ListResultPage) Response() ListResult

Response returns the raw server response from the last page request.

func (ListResultPage) Values Uses

func (page ListResultPage) Values() []Subscription

Values returns the slice of values for the current page or nil if there are no values.

type Location Uses

type Location struct {
    // ID - READ-ONLY; The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus.
    ID  *string `json:"id,omitempty"`
    // SubscriptionID - READ-ONLY; The subscription ID.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // Name - READ-ONLY; The location name.
    Name *string `json:"name,omitempty"`
    // DisplayName - READ-ONLY; The display name of the location.
    DisplayName *string `json:"displayName,omitempty"`
    // Latitude - READ-ONLY; The latitude of the location.
    Latitude *string `json:"latitude,omitempty"`
    // Longitude - READ-ONLY; The longitude of the location.
    Longitude *string `json:"longitude,omitempty"`
}

Location location information.

type LocationListResult Uses

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

LocationListResult location list operation response.

type ManagedByTenant Uses

type ManagedByTenant struct {
    // TenantID - READ-ONLY; The tenant ID of the managing tenant. This is a GUID.
    TenantID *string `json:"tenantId,omitempty"`
}

ManagedByTenant information about a tenant managing the subscription.

type Operation Uses

type Operation struct {
    // Name - Operation name: {provider}/{resource}/{operation}
    Name *string `json:"name,omitempty"`
    // Display - The object that represents the operation.
    Display *OperationDisplay `json:"display,omitempty"`
}

Operation microsoft.Resources operation

type OperationDisplay Uses

type OperationDisplay struct {
    // Provider - Service provider: Microsoft.Resources
    Provider *string `json:"provider,omitempty"`
    // Resource - Resource on which the operation is performed: Profile, endpoint, etc.
    Resource *string `json:"resource,omitempty"`
    // Operation - Operation type: Read, write, delete, etc.
    Operation *string `json:"operation,omitempty"`
    // Description - Description of the operation.
    Description *string `json:"description,omitempty"`
}

OperationDisplay the object that represents the operation.

type OperationListResult Uses

type OperationListResult struct {
    autorest.Response `json:"-"`
    // Value - List of Microsoft.Resources operations.
    Value *[]Operation `json:"value,omitempty"`
    // NextLink - URL to get the next set of operation list results if there are any.
    NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) IsEmpty Uses

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator Uses

type OperationListResultIterator struct {
    // contains filtered or unexported fields
}

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator Uses

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next Uses

func (iter *OperationListResultIterator) 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. Deprecated: Use NextWithContext() instead.

func (*OperationListResultIterator) NextWithContext Uses

func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListResultIterator) NotDone Uses

func (iter OperationListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListResultIterator) Response Uses

func (iter OperationListResultIterator) Response() OperationListResult

Response returns the raw server response from the last page request.

func (OperationListResultIterator) Value Uses

func (iter OperationListResultIterator) Value() Operation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListResultPage Uses

type OperationListResultPage struct {
    // contains filtered or unexported fields
}

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage Uses

func NewOperationListResultPage(getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next Uses

func (page *OperationListResultPage) 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. Deprecated: Use NextWithContext() instead.

func (*OperationListResultPage) NextWithContext Uses

func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (OperationListResultPage) NotDone Uses

func (page OperationListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListResultPage) Response Uses

func (page OperationListResultPage) Response() OperationListResult

Response returns the raw server response from the last page request.

func (OperationListResultPage) Values Uses

func (page OperationListResultPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type OperationsClient Uses

type OperationsClient struct {
    BaseClient
}

OperationsClient 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 NewOperationsClient Uses

func NewOperationsClient() OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

func NewOperationsClientWithBaseURI(baseURI string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List Uses

func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List lists all of the available Microsoft.Resources REST API operations.

func (OperationsClient) ListComplete Uses

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer Uses

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

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

func (OperationsClient) ListSender Uses

func (client OperationsClient) 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 Policies Uses

type Policies struct {
    // LocationPlacementID - READ-ONLY; 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 - READ-ONLY; The subscription quota ID.
    QuotaID *string `json:"quotaId,omitempty"`
    // SpendingLimit - READ-ONLY; The subscription spending limit. Possible values include: 'On', 'Off', 'CurrentPeriodOff'
    SpendingLimit SpendingLimit `json:"spendingLimit,omitempty"`
}

Policies subscription policies.

type SpendingLimit Uses

type SpendingLimit string

SpendingLimit enumerates the values for spending limit.

const (
    // CurrentPeriodOff ...
    CurrentPeriodOff SpendingLimit = "CurrentPeriodOff"
    // Off ...
    Off SpendingLimit = "Off"
    // On ...
    On  SpendingLimit = "On"
)

func PossibleSpendingLimitValues Uses

func PossibleSpendingLimitValues() []SpendingLimit

PossibleSpendingLimitValues returns an array of possible values for the SpendingLimit const type.

type State Uses

type State string

State enumerates the values for state.

const (
    // Deleted ...
    Deleted State = "Deleted"
    // Disabled ...
    Disabled State = "Disabled"
    // Enabled ...
    Enabled State = "Enabled"
    // PastDue ...
    PastDue State = "PastDue"
    // Warned ...
    Warned State = "Warned"
)

func PossibleStateValues Uses

func PossibleStateValues() []State

PossibleStateValues returns an array of possible values for the State const type.

type Subscription Uses

type Subscription struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; The fully qualified ID for the subscription. For example, /subscriptions/00000000-0000-0000-0000-000000000000.
    ID  *string `json:"id,omitempty"`
    // SubscriptionID - READ-ONLY; The subscription ID.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // DisplayName - READ-ONLY; The subscription display name.
    DisplayName *string `json:"displayName,omitempty"`
    // TenantID - READ-ONLY; The subscription tenant ID.
    TenantID *string `json:"tenantId,omitempty"`
    // State - READ-ONLY; 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"`
    // ManagedByTenants - An array containing the tenants managing the subscription.
    ManagedByTenants *[]ManagedByTenant `json:"managedByTenants,omitempty"`
}

Subscription subscription information.

type TenantIDDescription Uses

type TenantIDDescription struct {
    // ID - READ-ONLY; The fully qualified ID of the tenant. For example, /tenants/00000000-0000-0000-0000-000000000000.
    ID  *string `json:"id,omitempty"`
    // TenantID - READ-ONLY; The tenant ID. For example, 00000000-0000-0000-0000-000000000000.
    TenantID *string `json:"tenantId,omitempty"`
}

TenantIDDescription tenant Id information.

type TenantListResult Uses

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 Uses

func (tlr TenantListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type TenantListResultIterator Uses

type TenantListResultIterator struct {
    // contains filtered or unexported fields
}

TenantListResultIterator provides access to a complete listing of TenantIDDescription values.

func NewTenantListResultIterator Uses

func NewTenantListResultIterator(page TenantListResultPage) TenantListResultIterator

Creates a new instance of the TenantListResultIterator type.

func (*TenantListResultIterator) Next Uses

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. Deprecated: Use NextWithContext() instead.

func (*TenantListResultIterator) NextWithContext Uses

func (iter *TenantListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 Uses

func (iter TenantListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (TenantListResultIterator) Response Uses

func (iter TenantListResultIterator) Response() TenantListResult

Response returns the raw server response from the last page request.

func (TenantListResultIterator) Value Uses

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 Uses

type TenantListResultPage struct {
    // contains filtered or unexported fields
}

TenantListResultPage contains a page of TenantIDDescription values.

func NewTenantListResultPage Uses

func NewTenantListResultPage(getNextPage func(context.Context, TenantListResult) (TenantListResult, error)) TenantListResultPage

Creates a new instance of the TenantListResultPage type.

func (*TenantListResultPage) Next Uses

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. Deprecated: Use NextWithContext() instead.

func (*TenantListResultPage) NextWithContext Uses

func (page *TenantListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 Uses

func (page TenantListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (TenantListResultPage) Response Uses

func (page TenantListResultPage) Response() TenantListResult

Response returns the raw server response from the last page request.

func (TenantListResultPage) Values Uses

func (page TenantListResultPage) Values() []TenantIDDescription

Values returns the slice of values for the current page or nil if there are no values.

type TenantsClient Uses

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 Uses

func NewTenantsClient() TenantsClient

NewTenantsClient creates an instance of the TenantsClient client.

func NewTenantsClientWithBaseURI Uses

func NewTenantsClientWithBaseURI(baseURI string) TenantsClient

NewTenantsClientWithBaseURI creates an instance of the TenantsClient client.

func (TenantsClient) List Uses

func (client TenantsClient) List(ctx context.Context) (result TenantListResultPage, err error)

List gets the tenants for your account.

func (TenantsClient) ListComplete Uses

func (client TenantsClient) ListComplete(ctx context.Context) (result TenantListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (TenantsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (TenantsClient) ListResponder Uses

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 Uses

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.

Directories

PathSynopsis
subscriptionsapi

Package subscriptions imports 7 packages (graph) and is imported by 5 packages. Updated 2019-10-01. Refresh now. Tools for package owners.