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

package subscriptions

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

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

Index

Package Files

client.go models.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 client for the Subscriptions methods of the Subscriptions service.

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 particular subscription. Parameters: subscriptionID - id of the 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 a list of the subscriptionIds.

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 gets a list of the subscription locations. Parameters: subscriptionID - id of the 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 - Gets or sets subscriptions.
    Value *[]Subscription `json:"value,omitempty"`
    // NextLink - Gets or sets 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 - Gets or sets the ID of the resource (/subscriptions/SubscriptionId).
    ID  *string `json:"id,omitempty"`
    // SubscriptionID - Gets or sets the subscription Id.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // Name - Gets or sets the location name
    Name *string `json:"name,omitempty"`
    // DisplayName - Gets or sets the display name of the location
    DisplayName *string `json:"displayName,omitempty"`
    // Latitude - Gets or sets the latitude of the location
    Latitude *string `json:"latitude,omitempty"`
    // Longitude - Gets or sets the longitude of the location
    Longitude *string `json:"longitude,omitempty"`
}

Location location information.

type LocationListResult Uses

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

LocationListResult location list operation response.

type Policies Uses

type Policies struct {
    // LocationPlacementID - Gets or sets the subscription location placement Id.
    LocationPlacementID *string `json:"locationPlacementId,omitempty"`
    // QuotaID - Gets or sets the subscription quota Id.
    QuotaID *string `json:"quotaId,omitempty"`
}

Policies subscription policies.

type Subscription Uses

type Subscription struct {
    autorest.Response `json:"-"`
    // ID - Gets or sets the ID of the resource (/subscriptions/SubscriptionId).
    ID  *string `json:"id,omitempty"`
    // SubscriptionID - Gets or sets the subscription Id.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // DisplayName - Gets or sets the subscription display name
    DisplayName *string `json:"displayName,omitempty"`
    // State - Gets or sets the subscription state
    State *string `json:"state,omitempty"`
    // SubscriptionPolicies - Gets or sets the subscription policies.
    SubscriptionPolicies *Policies `json:"subscriptionPolicies,omitempty"`
}

Subscription subscription information.

type TenantIDDescription Uses

type TenantIDDescription struct {
    // ID - Gets or sets Id
    ID  *string `json:"id,omitempty"`
    // TenantID - Gets or sets tenantId
    TenantID *string `json:"tenantId,omitempty"`
}

TenantIDDescription tenant Id information

type TenantListResult Uses

type TenantListResult struct {
    autorest.Response `json:"-"`
    // Value - Gets or sets tenant Ids.
    Value *[]TenantIDDescription `json:"value,omitempty"`
    // NextLink - Gets or sets the URL to get 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 client for the Tenants methods of the Subscriptions service.

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 a list of the tenantIds.

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 4 packages. Updated 2019-07-31. Refresh now. Tools for package owners.