...

Package subscription

import "github.com/Azure/azure-sdk-for-go/services/subscription/mgmt/2020-09-01/subscription"
Overview
Index
Subdirectories

Overview ▾

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/subscription/armsubscription(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/subscription/armsubscription). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package subscription implements the Azure ARM Subscription service API version .

The subscription client

Index ▾

Constants
func UserAgent() string
func Version() string
type AliasClient
    func NewAliasClient() AliasClient
    func NewAliasClientWithBaseURI(baseURI string) AliasClient
    func (client AliasClient) Create(ctx context.Context, aliasName string, body PutAliasRequest) (result AliasCreateFuture, err error)
    func (client AliasClient) CreatePreparer(ctx context.Context, aliasName string, body PutAliasRequest) (*http.Request, error)
    func (client AliasClient) CreateResponder(resp *http.Response) (result PutAliasResponse, err error)
    func (client AliasClient) CreateSender(req *http.Request) (future AliasCreateFuture, err error)
    func (client AliasClient) Delete(ctx context.Context, aliasName string) (result autorest.Response, err error)
    func (client AliasClient) DeletePreparer(ctx context.Context, aliasName string) (*http.Request, error)
    func (client AliasClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
    func (client AliasClient) DeleteSender(req *http.Request) (*http.Response, error)
    func (client AliasClient) Get(ctx context.Context, aliasName string) (result PutAliasResponse, err error)
    func (client AliasClient) GetPreparer(ctx context.Context, aliasName string) (*http.Request, error)
    func (client AliasClient) GetResponder(resp *http.Response) (result PutAliasResponse, err error)
    func (client AliasClient) GetSender(req *http.Request) (*http.Response, error)
    func (client AliasClient) List(ctx context.Context) (result PutAliasListResult, err error)
    func (client AliasClient) ListPreparer(ctx context.Context) (*http.Request, error)
    func (client AliasClient) ListResponder(resp *http.Response) (result PutAliasListResult, err error)
    func (client AliasClient) ListSender(req *http.Request) (*http.Response, error)
type AliasCreateFuture
    func (future *AliasCreateFuture) UnmarshalJSON(body []byte) error
type BaseClient
    func New() BaseClient
    func NewWithBaseURI(baseURI string) BaseClient
type CanceledSubscriptionID
    func (csi CanceledSubscriptionID) MarshalJSON() ([]byte, error)
type Client
    func NewClient() Client
    func NewClientWithBaseURI(baseURI string) Client
    func (client Client) Cancel(ctx context.Context, subscriptionID string) (result CanceledSubscriptionID, err error)
    func (client Client) CancelPreparer(ctx context.Context, subscriptionID string) (*http.Request, error)
    func (client Client) CancelResponder(resp *http.Response) (result CanceledSubscriptionID, err error)
    func (client Client) CancelSender(req *http.Request) (*http.Response, error)
    func (client Client) Enable(ctx context.Context, subscriptionID string) (result EnabledSubscriptionID, err error)
    func (client Client) EnablePreparer(ctx context.Context, subscriptionID string) (*http.Request, error)
    func (client Client) EnableResponder(resp *http.Response) (result EnabledSubscriptionID, err error)
    func (client Client) EnableSender(req *http.Request) (*http.Response, error)
    func (client Client) Rename(ctx context.Context, subscriptionID string, body Name) (result RenamedSubscriptionID, err error)
    func (client Client) RenamePreparer(ctx context.Context, subscriptionID string, body Name) (*http.Request, error)
    func (client Client) RenameResponder(resp *http.Response) (result RenamedSubscriptionID, err error)
    func (client Client) RenameSender(req *http.Request) (*http.Response, error)
type EnabledSubscriptionID
    func (esi EnabledSubscriptionID) MarshalJSON() ([]byte, error)
type ErrorResponse
type ErrorResponseBody
type ListResult
    func (lr ListResult) IsEmpty() bool
type ListResultIterator
    func NewListResultIterator(page ListResultPage) ListResultIterator
    func (iter *ListResultIterator) Next() error
    func (iter *ListResultIterator) NextWithContext(ctx context.Context) (err error)
    func (iter ListResultIterator) NotDone() bool
    func (iter ListResultIterator) Response() ListResult
    func (iter ListResultIterator) Value() Model
type ListResultPage
    func NewListResultPage(cur ListResult, getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage
    func (page *ListResultPage) Next() error
    func (page *ListResultPage) NextWithContext(ctx context.Context) (err error)
    func (page ListResultPage) NotDone() bool
    func (page ListResultPage) Response() ListResult
    func (page ListResultPage) Values() []Model
type Location
    func (l Location) MarshalJSON() ([]byte, error)
type LocationListResult
type Model
    func (mVar Model) MarshalJSON() ([]byte, error)
type Name
type Operation
type OperationDisplay
type OperationListResult
type OperationsClient
    func NewOperationsClient() OperationsClient
    func NewOperationsClientWithBaseURI(baseURI string) OperationsClient
    func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
    func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
    func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
    func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
type Policies
    func (p Policies) MarshalJSON() ([]byte, error)
type ProvisioningState
    func PossibleProvisioningStateValues() []ProvisioningState
type PutAliasListResult
    func (palr PutAliasListResult) MarshalJSON() ([]byte, error)
type PutAliasRequest
type PutAliasRequestProperties
type PutAliasResponse
    func (par PutAliasResponse) MarshalJSON() ([]byte, error)
type PutAliasResponseProperties
    func (parp PutAliasResponseProperties) MarshalJSON() ([]byte, error)
type RenamedSubscriptionID
    func (rsi RenamedSubscriptionID) MarshalJSON() ([]byte, error)
type SpendingLimit
    func PossibleSpendingLimitValues() []SpendingLimit
type State
    func PossibleStateValues() []State
type SubscriptionsClient
    func NewSubscriptionsClient() SubscriptionsClient
    func NewSubscriptionsClientWithBaseURI(baseURI string) SubscriptionsClient
    func (client SubscriptionsClient) Get(ctx context.Context, subscriptionID string) (result Model, err error)
    func (client SubscriptionsClient) GetPreparer(ctx context.Context, subscriptionID string) (*http.Request, error)
    func (client SubscriptionsClient) GetResponder(resp *http.Response) (result Model, err error)
    func (client SubscriptionsClient) GetSender(req *http.Request) (*http.Response, error)
    func (client SubscriptionsClient) List(ctx context.Context) (result ListResultPage, err error)
    func (client SubscriptionsClient) ListComplete(ctx context.Context) (result ListResultIterator, err error)
    func (client SubscriptionsClient) ListLocations(ctx context.Context, subscriptionID string) (result LocationListResult, err error)
    func (client SubscriptionsClient) ListLocationsPreparer(ctx context.Context, subscriptionID string) (*http.Request, error)
    func (client SubscriptionsClient) ListLocationsResponder(resp *http.Response) (result LocationListResult, err error)
    func (client SubscriptionsClient) ListLocationsSender(req *http.Request) (*http.Response, error)
    func (client SubscriptionsClient) ListPreparer(ctx context.Context) (*http.Request, error)
    func (client SubscriptionsClient) ListResponder(resp *http.Response) (result ListResult, err error)
    func (client SubscriptionsClient) ListSender(req *http.Request) (*http.Response, error)
type TenantIDDescription
    func (tid TenantIDDescription) MarshalJSON() ([]byte, error)
type TenantListResult
    func (tlr TenantListResult) IsEmpty() bool
type TenantListResultIterator
    func NewTenantListResultIterator(page TenantListResultPage) TenantListResultIterator
    func (iter *TenantListResultIterator) Next() error
    func (iter *TenantListResultIterator) NextWithContext(ctx context.Context) (err error)
    func (iter TenantListResultIterator) NotDone() bool
    func (iter TenantListResultIterator) Response() TenantListResult
    func (iter TenantListResultIterator) Value() TenantIDDescription
type TenantListResultPage
    func NewTenantListResultPage(cur TenantListResult, getNextPage func(context.Context, TenantListResult) (TenantListResult, error)) TenantListResultPage
    func (page *TenantListResultPage) Next() error
    func (page *TenantListResultPage) NextWithContext(ctx context.Context) (err error)
    func (page TenantListResultPage) NotDone() bool
    func (page TenantListResultPage) Response() TenantListResult
    func (page TenantListResultPage) Values() []TenantIDDescription
type TenantsClient
    func NewTenantsClient() TenantsClient
    func NewTenantsClientWithBaseURI(baseURI string) 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)
type Workload
    func PossibleWorkloadValues() []Workload

Package files

alias.go client.go enums.go models.go operations.go subscription.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

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.

type AliasClient

AliasClient is the the subscription client

type AliasClient struct {
    BaseClient
}

func NewAliasClient

func NewAliasClient() AliasClient

NewAliasClient creates an instance of the AliasClient client.

func NewAliasClientWithBaseURI

func NewAliasClientWithBaseURI(baseURI string) AliasClient

NewAliasClientWithBaseURI creates an instance of the AliasClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (AliasClient) Create

func (client AliasClient) Create(ctx context.Context, aliasName string, body PutAliasRequest) (result AliasCreateFuture, err error)

Create create Alias Subscription. Parameters: aliasName - alias Name

func (AliasClient) CreatePreparer

func (client AliasClient) CreatePreparer(ctx context.Context, aliasName string, body PutAliasRequest) (*http.Request, error)

CreatePreparer prepares the Create request.

func (AliasClient) CreateResponder

func (client AliasClient) CreateResponder(resp *http.Response) (result PutAliasResponse, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (AliasClient) CreateSender

func (client AliasClient) CreateSender(req *http.Request) (future AliasCreateFuture, err error)

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

func (AliasClient) Delete

func (client AliasClient) Delete(ctx context.Context, aliasName string) (result autorest.Response, err error)

Delete delete Alias. Parameters: aliasName - alias Name

func (AliasClient) DeletePreparer

func (client AliasClient) DeletePreparer(ctx context.Context, aliasName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (AliasClient) DeleteResponder

func (client AliasClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (AliasClient) DeleteSender

func (client AliasClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (AliasClient) Get

func (client AliasClient) Get(ctx context.Context, aliasName string) (result PutAliasResponse, err error)

Get get Alias Subscription. Parameters: aliasName - alias Name

func (AliasClient) GetPreparer

func (client AliasClient) GetPreparer(ctx context.Context, aliasName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AliasClient) GetResponder

func (client AliasClient) GetResponder(resp *http.Response) (result PutAliasResponse, err error)

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

func (AliasClient) GetSender

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

func (client AliasClient) List(ctx context.Context) (result PutAliasListResult, err error)

List get Alias Subscription.

func (AliasClient) ListPreparer

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

ListPreparer prepares the List request.

func (AliasClient) ListResponder

func (client AliasClient) ListResponder(resp *http.Response) (result PutAliasListResult, err error)

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

func (AliasClient) ListSender

func (client AliasClient) 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 AliasCreateFuture

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

type AliasCreateFuture struct {
    azure.FutureAPI
    // Result returns the result of the asynchronous operation.
    // If the operation has not completed it will return an error.
    Result func(AliasClient) (PutAliasResponse, error)
}

func (*AliasCreateFuture) UnmarshalJSON

func (future *AliasCreateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type BaseClient

BaseClient is the base client for Subscription.

type BaseClient struct {
    autorest.Client
    BaseURI string
}

func New

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type CanceledSubscriptionID

CanceledSubscriptionID the ID of the canceled subscription

type CanceledSubscriptionID struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The ID of the canceled subscription
    Value *string `json:"value,omitempty"`
}

func (CanceledSubscriptionID) MarshalJSON

func (csi CanceledSubscriptionID) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CanceledSubscriptionID.

type Client

Client is the the subscription client

type Client struct {
    BaseClient
}

func NewClient

func NewClient() Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI

func NewClientWithBaseURI(baseURI string) Client

NewClientWithBaseURI creates an instance of the Client client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (Client) Cancel

func (client Client) Cancel(ctx context.Context, subscriptionID string) (result CanceledSubscriptionID, err error)

Cancel the operation to cancel a subscription Parameters: subscriptionID - subscription Id.

func (Client) CancelPreparer

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

CancelPreparer prepares the Cancel request.

func (Client) CancelResponder

func (client Client) CancelResponder(resp *http.Response) (result CanceledSubscriptionID, err error)

CancelResponder handles the response to the Cancel request. The method always closes the http.Response Body.

func (Client) CancelSender

func (client Client) CancelSender(req *http.Request) (*http.Response, error)

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

func (Client) Enable

func (client Client) Enable(ctx context.Context, subscriptionID string) (result EnabledSubscriptionID, err error)

Enable the operation to enable a subscription Parameters: subscriptionID - subscription Id.

func (Client) EnablePreparer

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

EnablePreparer prepares the Enable request.

func (Client) EnableResponder

func (client Client) EnableResponder(resp *http.Response) (result EnabledSubscriptionID, err error)

EnableResponder handles the response to the Enable request. The method always closes the http.Response Body.

func (Client) EnableSender

func (client Client) EnableSender(req *http.Request) (*http.Response, error)

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

func (Client) Rename

func (client Client) Rename(ctx context.Context, subscriptionID string, body Name) (result RenamedSubscriptionID, err error)

Rename the operation to rename a subscription Parameters: subscriptionID - subscription Id. body - subscription Name

func (Client) RenamePreparer

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

RenamePreparer prepares the Rename request.

func (Client) RenameResponder

func (client Client) RenameResponder(resp *http.Response) (result RenamedSubscriptionID, err error)

RenameResponder handles the response to the Rename request. The method always closes the http.Response Body.

func (Client) RenameSender

func (client Client) RenameSender(req *http.Request) (*http.Response, error)

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

type EnabledSubscriptionID

EnabledSubscriptionID the ID of the subscriptions that is being enabled

type EnabledSubscriptionID struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The ID of the subscriptions that is being enabled
    Value *string `json:"value,omitempty"`
}

func (EnabledSubscriptionID) MarshalJSON

func (esi EnabledSubscriptionID) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EnabledSubscriptionID.

type ErrorResponse

ErrorResponse describes the format of Error response.

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

type ErrorResponseBody

ErrorResponseBody error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

type ErrorResponseBody struct {
    // Error - The details of the error.
    Error *ErrorResponse `json:"error,omitempty"`
}

type ListResult

ListResult subscription list operation response.

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"`
}

func (ListResult) IsEmpty

func (lr ListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListResultIterator

ListResultIterator provides access to a complete listing of Model values.

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

func NewListResultIterator

func NewListResultIterator(page ListResultPage) ListResultIterator

Creates a new instance of the ListResultIterator type.

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

func (*ListResultIterator) NextWithContext

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

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

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

type ListResultPage

ListResultPage contains a page of Model values.

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

func NewListResultPage

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

Creates a new instance of the ListResultPage type.

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

func (*ListResultPage) NextWithContext

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

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

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

type Location

Location location information.

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"`
}

func (Location) MarshalJSON

func (l Location) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Location.

type LocationListResult

LocationListResult location list operation response.

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

type Model

Model subscription information.

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"`
}

func (Model) MarshalJSON

func (mVar Model) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Model.

type Name

Name the new name of the subscription.

type Name struct {
    // SubscriptionName - New subscription name
    SubscriptionName *string `json:"subscriptionName,omitempty"`
}

type Operation

Operation REST API operation

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"`
}

type OperationDisplay

OperationDisplay the object that represents the operation.

type OperationDisplay struct {
    // Provider - Service provider: Microsoft.Subscription
    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"`
}

type OperationListResult

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

type OperationListResult struct {
    autorest.Response `json:"-"`
    // Value - List of 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"`
}

type OperationsClient

OperationsClient is the the subscription client

type OperationsClient struct {
    BaseClient
}

func NewOperationsClient

func NewOperationsClient() OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List

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

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

func (OperationsClient) ListPreparer

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

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

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

Policies subscription policies.

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"`
}

func (Policies) MarshalJSON

func (p Policies) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Policies.

type ProvisioningState

ProvisioningState enumerates the values for provisioning state.

type ProvisioningState string
const (
    // Accepted ...
    Accepted ProvisioningState = "Accepted"
    // Failed ...
    Failed ProvisioningState = "Failed"
    // Succeeded ...
    Succeeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type PutAliasListResult

PutAliasListResult the list of aliases.

type PutAliasListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The list of alias.
    Value *[]PutAliasResponse `json:"value,omitempty"`
    // NextLink - READ-ONLY; The link (url) to the next page of results.
    NextLink *string `json:"nextLink,omitempty"`
}

func (PutAliasListResult) MarshalJSON

func (palr PutAliasListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PutAliasListResult.

type PutAliasRequest

PutAliasRequest the parameters required to create a new subscription.

type PutAliasRequest struct {
    // Properties - Put alias request properties.
    Properties *PutAliasRequestProperties `json:"properties,omitempty"`
}

type PutAliasRequestProperties

PutAliasRequestProperties put subscription properties.

type PutAliasRequestProperties struct {
    // DisplayName - The friendly name of the subscription.
    DisplayName *string `json:"displayName,omitempty"`
    // Workload - The workload type of the subscription. It can be either Production or DevTest. Possible values include: 'Production', 'DevTest'
    Workload Workload `json:"workload,omitempty"`
    // BillingScope - Determines whether subscription is fieldLed, partnerLed or LegacyEA
    BillingScope *string `json:"billingScope,omitempty"`
    // SubscriptionID - This parameter can be used to create alias for existing subscription Id
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ResellerID - Reseller ID, basically MPN Id
    ResellerID *string `json:"resellerId,omitempty"`
}

type PutAliasResponse

PutAliasResponse subscription Information with the alias.

type PutAliasResponse struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; Fully qualified ID for the alias resource.
    ID *string `json:"id,omitempty"`
    // Name - READ-ONLY; Alias ID.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; Resource type, Microsoft.Subscription/aliases.
    Type *string `json:"type,omitempty"`
    // Properties - Put Alias response properties.
    Properties *PutAliasResponseProperties `json:"properties,omitempty"`
}

func (PutAliasResponse) MarshalJSON

func (par PutAliasResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PutAliasResponse.

type PutAliasResponseProperties

PutAliasResponseProperties put subscription creation result properties.

type PutAliasResponseProperties struct {
    // SubscriptionID - READ-ONLY; Newly created subscription Id.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ProvisioningState - The provisioning state of the resource. Possible values include: 'Accepted', 'Succeeded', 'Failed'
    ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}

func (PutAliasResponseProperties) MarshalJSON

func (parp PutAliasResponseProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PutAliasResponseProperties.

type RenamedSubscriptionID

RenamedSubscriptionID the ID of the subscriptions that is being renamed

type RenamedSubscriptionID struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The ID of the subscriptions that is being renamed
    Value *string `json:"value,omitempty"`
}

func (RenamedSubscriptionID) MarshalJSON

func (rsi RenamedSubscriptionID) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RenamedSubscriptionID.

type SpendingLimit

SpendingLimit enumerates the values for spending limit.

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

func PossibleSpendingLimitValues

func PossibleSpendingLimitValues() []SpendingLimit

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

type State

State enumerates the values for state.

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

func PossibleStateValues

func PossibleStateValues() []State

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

type SubscriptionsClient

SubscriptionsClient is the the subscription client

type SubscriptionsClient struct {
    BaseClient
}

func NewSubscriptionsClient

func NewSubscriptionsClient() SubscriptionsClient

NewSubscriptionsClient creates an instance of the SubscriptionsClient client.

func NewSubscriptionsClientWithBaseURI

func NewSubscriptionsClientWithBaseURI(baseURI string) SubscriptionsClient

NewSubscriptionsClientWithBaseURI creates an instance of the SubscriptionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (SubscriptionsClient) Get

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

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

GetPreparer prepares the Get request.

func (SubscriptionsClient) GetResponder

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

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

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

List gets all subscriptions for a tenant.

func (SubscriptionsClient) ListComplete

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

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

func (SubscriptionsClient) ListLocations

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

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

ListLocationsPreparer prepares the ListLocations request.

func (SubscriptionsClient) ListLocationsResponder

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

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

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

ListPreparer prepares the List request.

func (SubscriptionsClient) ListResponder

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

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

TenantIDDescription tenant Id information.

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"`
}

func (TenantIDDescription) MarshalJSON

func (tid TenantIDDescription) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TenantIDDescription.

type TenantListResult

TenantListResult tenant Ids information.

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"`
}

func (TenantListResult) IsEmpty

func (tlr TenantListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type TenantListResultIterator

TenantListResultIterator provides access to a complete listing of TenantIDDescription values.

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

func NewTenantListResultIterator

func NewTenantListResultIterator(page TenantListResultPage) TenantListResultIterator

Creates a new instance of the TenantListResultIterator type.

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

func (*TenantListResultIterator) NextWithContext

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

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

TenantListResultPage contains a page of TenantIDDescription values.

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

func NewTenantListResultPage

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

Creates a new instance of the TenantListResultPage type.

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

func (*TenantListResultPage) NextWithContext

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

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

TenantsClient is the the subscription client

type TenantsClient struct {
    BaseClient
}

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

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

func (client TenantsClient) ListPreparer(ctx context.Context) (*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.

type Workload

Workload enumerates the values for workload.

type Workload string
const (
    // DevTest ...
    DevTest Workload = "DevTest"
    // Production ...
    Production Workload = "Production"
)

func PossibleWorkloadValues

func PossibleWorkloadValues() []Workload

PossibleWorkloadValues returns an array of possible values for the Workload const type.

Subdirectories

Name Synopsis
..
subscriptionapi Deprecated: Please note, this package has been deprecated.