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

package subscription

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

Package subscription implements the Azure ARM Subscription service API version .

The subscription client

Index

Package Files

client.go enums.go models.go operation.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 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 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 Uses

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

CanceledSubscriptionID the ID of the canceled subscription

type Client Uses

type Client struct {
    BaseClient
}

Client is the the subscription client

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

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 Uses

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

CancelPreparer prepares the Cancel request.

func (Client) CancelResponder Uses

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 Uses

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

func (client Client) CreateAlias(ctx context.Context, aliasName string, body PutAliasRequest) (result CreateAliasFuture, err error)

CreateAlias create Alias Subscription. Parameters: aliasName - alias Name

func (Client) CreateAliasPreparer Uses

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

CreateAliasPreparer prepares the CreateAlias request.

func (Client) CreateAliasResponder Uses

func (client Client) CreateAliasResponder(resp *http.Response) (result PutAliasResponse, err error)

CreateAliasResponder handles the response to the CreateAlias request. The method always closes the http.Response Body.

func (Client) CreateAliasSender Uses

func (client Client) CreateAliasSender(req *http.Request) (future CreateAliasFuture, err error)

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

func (Client) CreateCspSubscription Uses

func (client Client) CreateCspSubscription(ctx context.Context, billingAccountName string, customerName string, body ModernCspSubscriptionCreationParameters) (result CreateCspSubscriptionFuture, err error)

CreateCspSubscription the operation to create a new CSP subscription. Parameters: billingAccountName - the name of the Microsoft Customer Agreement billing account for which you want to create the subscription. customerName - the name of the customer. body - the subscription creation parameters.

func (Client) CreateCspSubscriptionPreparer Uses

func (client Client) CreateCspSubscriptionPreparer(ctx context.Context, billingAccountName string, customerName string, body ModernCspSubscriptionCreationParameters) (*http.Request, error)

CreateCspSubscriptionPreparer prepares the CreateCspSubscription request.

func (Client) CreateCspSubscriptionResponder Uses

func (client Client) CreateCspSubscriptionResponder(resp *http.Response) (result CreationResult, err error)

CreateCspSubscriptionResponder handles the response to the CreateCspSubscription request. The method always closes the http.Response Body.

func (Client) CreateCspSubscriptionSender Uses

func (client Client) CreateCspSubscriptionSender(req *http.Request) (future CreateCspSubscriptionFuture, err error)

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

func (Client) CreateSubscription Uses

func (client Client) CreateSubscription(ctx context.Context, billingAccountName string, billingProfileName string, invoiceSectionName string, body ModernSubscriptionCreationParameters) (result CreateSubscriptionFuture, err error)

CreateSubscription the operation to create a new WebDirect or EA Azure subscription. Parameters: billingAccountName - the name of the Microsoft Customer Agreement billing account for which you want to create the subscription. billingProfileName - the name of the billing profile in the billing account for which you want to create the subscription. invoiceSectionName - the name of the invoice section in the billing account for which you want to create the subscription. body - the subscription creation parameters.

func (Client) CreateSubscriptionInEnrollmentAccount Uses

func (client Client) CreateSubscriptionInEnrollmentAccount(ctx context.Context, enrollmentAccountName string, body CreationParameters) (result CreateSubscriptionInEnrollmentAccountFuture, 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 (Client) CreateSubscriptionInEnrollmentAccountPreparer Uses

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

CreateSubscriptionInEnrollmentAccountPreparer prepares the CreateSubscriptionInEnrollmentAccount request.

func (Client) CreateSubscriptionInEnrollmentAccountResponder Uses

func (client Client) 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 (Client) CreateSubscriptionInEnrollmentAccountSender Uses

func (client Client) CreateSubscriptionInEnrollmentAccountSender(req *http.Request) (future CreateSubscriptionInEnrollmentAccountFuture, err error)

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

func (Client) CreateSubscriptionPreparer Uses

func (client Client) CreateSubscriptionPreparer(ctx context.Context, billingAccountName string, billingProfileName string, invoiceSectionName string, body ModernSubscriptionCreationParameters) (*http.Request, error)

CreateSubscriptionPreparer prepares the CreateSubscription request.

func (Client) CreateSubscriptionResponder Uses

func (client Client) CreateSubscriptionResponder(resp *http.Response) (result CreationResult, err error)

CreateSubscriptionResponder handles the response to the CreateSubscription request. The method always closes the http.Response Body.

func (Client) CreateSubscriptionSender Uses

func (client Client) CreateSubscriptionSender(req *http.Request) (future CreateSubscriptionFuture, err error)

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

func (Client) DeleteAlias Uses

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

DeleteAlias delete Alias. Parameters: aliasName - alias Name

func (Client) DeleteAliasPreparer Uses

func (client Client) DeleteAliasPreparer(ctx context.Context, aliasName string) (*http.Request, error)

DeleteAliasPreparer prepares the DeleteAlias request.

func (Client) DeleteAliasResponder Uses

func (client Client) DeleteAliasResponder(resp *http.Response) (result autorest.Response, err error)

DeleteAliasResponder handles the response to the DeleteAlias request. The method always closes the http.Response Body.

func (Client) DeleteAliasSender Uses

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

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

func (Client) Enable Uses

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 Uses

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

EnablePreparer prepares the Enable request.

func (Client) EnableResponder Uses

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 Uses

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

func (client Client) GetAlias(ctx context.Context, aliasName string) (result PutAliasResponse, err error)

GetAlias get Alias Subscription. Parameters: aliasName - alias Name

func (Client) GetAliasPreparer Uses

func (client Client) GetAliasPreparer(ctx context.Context, aliasName string) (*http.Request, error)

GetAliasPreparer prepares the GetAlias request.

func (Client) GetAliasResponder Uses

func (client Client) GetAliasResponder(resp *http.Response) (result PutAliasResponse, err error)

GetAliasResponder handles the response to the GetAlias request. The method always closes the http.Response Body.

func (Client) GetAliasSender Uses

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

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

func (Client) ListAlias Uses

func (client Client) ListAlias(ctx context.Context) (result PutAliasListResult, err error)

ListAlias get Alias Subscription.

func (Client) ListAliasPreparer Uses

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

ListAliasPreparer prepares the ListAlias request.

func (Client) ListAliasResponder Uses

func (client Client) ListAliasResponder(resp *http.Response) (result PutAliasListResult, err error)

ListAliasResponder handles the response to the ListAlias request. The method always closes the http.Response Body.

func (Client) ListAliasSender Uses

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

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

func (Client) Rename Uses

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 Uses

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

RenamePreparer prepares the Rename request.

func (Client) RenameResponder Uses

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 Uses

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

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

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

type CreateCspSubscriptionFuture Uses

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

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

type CreateSubscriptionFuture Uses

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

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

type CreateSubscriptionInEnrollmentAccountFuture Uses

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

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

type CreationParameters Uses

type CreationParameters struct {
    // DisplayName - The display name of the subscription.
    DisplayName *string `json:"displayName,omitempty"`
    // ManagementGroupID - The Management Group Id.
    ManagementGroupID *string `json:"managementGroupId,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 EnabledSubscriptionID Uses

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

EnabledSubscriptionID the ID of the subscriptions that is being enabled

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

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

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

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(cur ListResult, 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.

func (Model) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Model.

type ModernCspSubscriptionCreationParameters Uses

type ModernCspSubscriptionCreationParameters struct {
    // DisplayName - The friendly name of the subscription.
    DisplayName *string `json:"displayName,omitempty"`
    // SkuID - The SKU ID of the Azure plan. Azure plan determines the pricing and service-level agreement of the subscription.  Use 001 for Microsoft Azure Plan and 002 for Microsoft Azure Plan for DevTest.
    SkuID *string `json:"skuId,omitempty"`
    // ResellerID - Reseller ID, basically MPN Id.
    ResellerID *string `json:"resellerId,omitempty"`
}

ModernCspSubscriptionCreationParameters the parameters required to create a new CSP subscription.

type ModernSubscriptionCreationParameters Uses

type ModernSubscriptionCreationParameters struct {
    // DisplayName - The friendly name of the subscription.
    DisplayName *string `json:"displayName,omitempty"`
    // SkuID - The SKU ID of the Azure plan. Azure plan determines the pricing and service-level agreement of the subscription.  Use 001 for Microsoft Azure Plan and 002 for Microsoft Azure Plan for DevTest.
    SkuID *string `json:"skuId,omitempty"`
    // CostCenter - If set, the cost center will show up on the Azure usage and charges file.
    CostCenter *string `json:"costCenter,omitempty"`
    // Owner - If specified, the AD principal will get owner access to the subscription, along with the user who is performing the create subscription operation
    Owner *AdPrincipal `json:"owner,omitempty"`
    // ManagementGroupID - The identifier of the management group to which this subscription will be associated.
    ManagementGroupID *string `json:"managementGroupId,omitempty"`
    // AdditionalParameters - Additional, untyped parameters to support custom subscription creation scenarios.
    AdditionalParameters map[string]interface{} `json:"additionalParameters"`
}

ModernSubscriptionCreationParameters the parameters required to create a new subscription.

func (ModernSubscriptionCreationParameters) MarshalJSON Uses

func (mscp ModernSubscriptionCreationParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ModernSubscriptionCreationParameters.

type Name Uses

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

Name the new name of the subscription.

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 {
    // Name - Operation name: {provider}/{resource}/{operation}
    Name *string `json:"name,omitempty"`
    // Display - The object that represents the operation.
    Display *OperationDisplay `json:"display,omitempty"`
}

Operation REST API operation

type OperationClient Uses

type OperationClient struct {
    BaseClient
}

OperationClient is the the subscription client

func NewOperationClient Uses

func NewOperationClient() OperationClient

NewOperationClient creates an instance of the OperationClient client.

func NewOperationClientWithBaseURI Uses

func NewOperationClientWithBaseURI(baseURI string) OperationClient

NewOperationClientWithBaseURI creates an instance of the OperationClient 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 (OperationClient) Get Uses

func (client OperationClient) Get(ctx context.Context, operationID string) (result CreationResult, err error)

Get get the status of the pending Microsoft.Subscription API operations. Parameters: operationID - the operation ID, which can be found from the Location field in the generate recommendation response header.

func (OperationClient) GetPreparer Uses

func (client OperationClient) GetPreparer(ctx context.Context, operationID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (OperationClient) GetResponder Uses

func (client OperationClient) GetResponder(resp *http.Response) (result CreationResult, err error)

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

func (OperationClient) GetSender Uses

func (client OperationClient) 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.

type OperationDisplay Uses

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

OperationDisplay the object that represents the operation.

type OperationListResult Uses

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

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

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

List lists all of the available 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 ProvisioningState Uses

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

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

func PossibleProvisioningStateValues Uses

func PossibleProvisioningStateValues() []ProvisioningState

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

type PutAliasListResult Uses

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

PutAliasListResult the list of aliases.

type PutAliasRequest Uses

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

PutAliasRequest the parameters required to create a new subscription.

type PutAliasRequestProperties Uses

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

PutAliasRequestProperties put subscription properties.

type PutAliasResponse Uses

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

PutAliasResponse subscription Information with the alias.

func (PutAliasResponse) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for PutAliasResponse.

type PutAliasResponseProperties Uses

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

PutAliasResponseProperties put subscription creation result properties.

func (PutAliasResponseProperties) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for PutAliasResponseProperties.

type RenamedSubscriptionID Uses

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

RenamedSubscriptionID the ID of the subscriptions that is being renamed

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 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 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(cur TenantListResult, 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 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 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.

type Workload Uses

type Workload string

Workload enumerates the values for workload.

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

func PossibleWorkloadValues Uses

func PossibleWorkloadValues() []Workload

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

Directories

PathSynopsis
subscriptionapi

Package subscription imports 9 packages (graph) and is imported by 2 packages. Updated 2021-01-23. Refresh now. Tools for package owners.