azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/preview/subscription/mgmt/2018-03-01-preview/subscription Index | Files | Directories

package subscription

import "github.com/Azure/azure-sdk-for-go/services/preview/subscription/mgmt/2018-03-01-preview/subscription"

Package subscription implements the Azure ARM Subscription service API version .

The subscription client

Index

Package Files

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

Constants

const (
    // DefaultBaseURI is the default URI used for the service Subscription
    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 AdPrincipal Uses

type AdPrincipal struct {
    // ObjectID - Object id of the Principal
    ObjectID *string `json:"objectId,omitempty"`
}

AdPrincipal active Directory Principal who’ll get owner access on the new subscription.

type BaseClient Uses

type BaseClient struct {
    autorest.Client
    BaseURI string
}

BaseClient is the base client for Subscription.

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

type CreationParameters struct {
    // DisplayName - The display name of the subscription.
    DisplayName *string `json:"displayName,omitempty"`
    // Owners - The list of principals that should be granted Owner access on the subscription. Principals should be of type User, Service Principal or Security Group.
    Owners *[]AdPrincipal `json:"owners,omitempty"`
    // OfferType - The offer type of the subscription. For example, MS-AZR-0017P (EnterpriseAgreement) and MS-AZR-0148P (EnterpriseAgreement devTest) are available. Only valid when creating a subscription in a enrollment account scope. Possible values include: 'MSAZR0017P', 'MSAZR0148P'
    OfferType OfferType `json:"offerType,omitempty"`
    // AdditionalParameters - Additional, untyped parameters to support custom subscription creation scenarios.
    AdditionalParameters map[string]interface{} `json:"additionalParameters"`
}

CreationParameters subscription Creation Parameters required to create a new Azure subscription.

func (CreationParameters) MarshalJSON Uses

func (cp CreationParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreationParameters.

type CreationResult Uses

type CreationResult struct {
    autorest.Response `json:"-"`
    // SubscriptionLink - The link to the new subscription. Use this link to check the status of subscription creation operation.
    SubscriptionLink *string `json:"subscriptionLink,omitempty"`
}

CreationResult the created subscription object.

type ErrorResponse Uses

type ErrorResponse struct {
    // Code - Error code
    Code *string `json:"code,omitempty"`
    // Message - Error message indicating why the operation failed.
    Message *string `json:"message,omitempty"`
}

ErrorResponse describes the format of Error response.

type FactoryClient Uses

type FactoryClient struct {
    BaseClient
}

FactoryClient is the the subscription client

func NewFactoryClient Uses

func NewFactoryClient() FactoryClient

NewFactoryClient creates an instance of the FactoryClient client.

func NewFactoryClientWithBaseURI Uses

func NewFactoryClientWithBaseURI(baseURI string) FactoryClient

NewFactoryClientWithBaseURI creates an instance of the FactoryClient client.

func (FactoryClient) CreateSubscriptionInEnrollmentAccount Uses

func (client FactoryClient) CreateSubscriptionInEnrollmentAccount(ctx context.Context, enrollmentAccountName string, body CreationParameters) (result FactoryCreateSubscriptionInEnrollmentAccountFuture, err error)

CreateSubscriptionInEnrollmentAccount creates an Azure subscription Parameters: enrollmentAccountName - the name of the enrollment account to which the subscription will be billed. body - the subscription creation parameters.

func (FactoryClient) CreateSubscriptionInEnrollmentAccountPreparer Uses

func (client FactoryClient) CreateSubscriptionInEnrollmentAccountPreparer(ctx context.Context, enrollmentAccountName string, body CreationParameters) (*http.Request, error)

CreateSubscriptionInEnrollmentAccountPreparer prepares the CreateSubscriptionInEnrollmentAccount request.

func (FactoryClient) CreateSubscriptionInEnrollmentAccountResponder Uses

func (client FactoryClient) CreateSubscriptionInEnrollmentAccountResponder(resp *http.Response) (result CreationResult, err error)

CreateSubscriptionInEnrollmentAccountResponder handles the response to the CreateSubscriptionInEnrollmentAccount request. The method always closes the http.Response Body.

func (FactoryClient) CreateSubscriptionInEnrollmentAccountSender Uses

func (client FactoryClient) CreateSubscriptionInEnrollmentAccountSender(req *http.Request) (future FactoryCreateSubscriptionInEnrollmentAccountFuture, err error)

CreateSubscriptionInEnrollmentAccountSender sends the CreateSubscriptionInEnrollmentAccount request. The method will close the http.Response Body if it receives an error.

type FactoryCreateSubscriptionInEnrollmentAccountFuture Uses

type FactoryCreateSubscriptionInEnrollmentAccountFuture struct {
    azure.Future
}

FactoryCreateSubscriptionInEnrollmentAccountFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*FactoryCreateSubscriptionInEnrollmentAccountFuture) Result Uses

func (future *FactoryCreateSubscriptionInEnrollmentAccountFuture) Result(client FactoryClient) (cr CreationResult, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ListResult Uses

type ListResult struct {
    autorest.Response `json:"-"`
    // Value - An array of subscriptions.
    Value *[]Model `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 Model 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() Model

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 Model 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() []Model

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

type Model 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"`
    // 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"`
}

Model subscription information.

type OfferType Uses

type OfferType string

OfferType enumerates the values for offer type.

const (
    // MSAZR0017P ...
    MSAZR0017P OfferType = "MS-AZR-0017P"
    // MSAZR0148P ...
    MSAZR0148P OfferType = "MS-AZR-0148P"
)

func PossibleOfferTypeValues Uses

func PossibleOfferTypeValues() []OfferType

PossibleOfferTypeValues returns an array of possible values for the OfferType const type.

type Operation Uses

type Operation struct {
    // ID - READ-ONLY; The operation Id.
    ID  *string `json:"id,omitempty"`
    // Status - Status of the pending subscription
    Status *string `json:"status,omitempty"`
    // StatusDetail - Status Detail of the pending subscription
    StatusDetail *string `json:"statusDetail,omitempty"`
}

Operation status of the subscription POST operation.

type OperationListResult Uses

type OperationListResult struct {
    autorest.Response `json:"-"`
    // Value - A list of pending SubscriptionOperations
    Value *[]Operation `json:"value,omitempty"`
}

OperationListResult a list of pending subscription operations.

type OperationsClient Uses

type OperationsClient struct {
    BaseClient
}

OperationsClient is the the subscription client

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 OperationListResult, err error)

List lists all of the available pending Microsoft.Subscription API operations.

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

type SubscriptionsClient struct {
    BaseClient
}

SubscriptionsClient is the the subscription client

func NewSubscriptionsClient Uses

func NewSubscriptionsClient() SubscriptionsClient

NewSubscriptionsClient creates an instance of the SubscriptionsClient client.

func NewSubscriptionsClientWithBaseURI Uses

func NewSubscriptionsClientWithBaseURI(baseURI string) SubscriptionsClient

NewSubscriptionsClientWithBaseURI creates an instance of the SubscriptionsClient client.

func (SubscriptionsClient) Get Uses

func (client SubscriptionsClient) Get(ctx context.Context, subscriptionID string) (result Model, err error)

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

func (SubscriptionsClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (SubscriptionsClient) GetResponder Uses

func (client SubscriptionsClient) GetResponder(resp *http.Response) (result Model, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (SubscriptionsClient) GetSender Uses

func (client SubscriptionsClient) 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 (SubscriptionsClient) List Uses

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

List gets all subscriptions for a tenant.

func (SubscriptionsClient) ListComplete Uses

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

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

func (SubscriptionsClient) ListLocations Uses

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

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

ListLocationsPreparer prepares the ListLocations request.

func (SubscriptionsClient) ListLocationsResponder Uses

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

func (client SubscriptionsClient) 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 (SubscriptionsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (SubscriptionsClient) ListResponder Uses

func (client SubscriptionsClient) 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 (SubscriptionsClient) ListSender Uses

func (client SubscriptionsClient) 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 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 the subscription client

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
subscriptionapi

Package subscription imports 8 packages (graph) and is imported by 9 packages. Updated 2019-08-10. Refresh now. Tools for package owners.