Documentation ¶
Overview ¶
Package subscriptions implements the Azure ARM Subscriptions service API version 2015-11-01.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type BaseClient
- func (client BaseClient) CheckResourceName(ctx context.Context, resourceNameDefinition *ResourceName) (result CheckResourceNameResult, err error)
- func (client BaseClient) CheckResourceNamePreparer(ctx context.Context, resourceNameDefinition *ResourceName) (*http.Request, error)
- func (client BaseClient) CheckResourceNameResponder(resp *http.Response) (result CheckResourceNameResult, err error)
- func (client BaseClient) CheckResourceNameSender(req *http.Request) (*http.Response, error)
- type CheckResourceNameResult
- type Client
- func (client Client) Get(ctx context.Context, subscriptionID string) (result Subscription, err error)
- func (client Client) GetPreparer(ctx context.Context, subscriptionID string) (*http.Request, error)
- func (client Client) GetResponder(resp *http.Response) (result Subscription, err error)
- func (client Client) GetSender(req *http.Request) (*http.Response, error)
- func (client Client) List(ctx context.Context) (result ListResultPage, err error)
- func (client Client) ListComplete(ctx context.Context) (result ListResultIterator, err error)
- func (client Client) ListLocations(ctx context.Context, subscriptionID string) (result LocationListResult, err error)
- func (client Client) ListLocationsPreparer(ctx context.Context, subscriptionID string) (*http.Request, error)
- func (client Client) ListLocationsResponder(resp *http.Response) (result LocationListResult, err error)
- func (client Client) ListLocationsSender(req *http.Request) (*http.Response, error)
- func (client Client) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client Client) ListResponder(resp *http.Response) (result ListResult, err error)
- func (client Client) ListSender(req *http.Request) (*http.Response, error)
- type ErrorDefinition
- type ErrorResponse
- type ListResult
- type ListResultIterator
- type ListResultPage
- type Location
- type LocationListResult
- type Policies
- type ResourceName
- type ResourceNameStatus
- type Subscription
- type TenantIDDescription
- type TenantListResult
- type 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 (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 (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)
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Subscriptions
DefaultBaseURI = "https://management.azure.com"
)
Variables ¶
This section is empty.
Functions ¶
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.
Types ¶
type BaseClient ¶
BaseClient is the base client for Subscriptions.
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).
func (BaseClient) CheckResourceName ¶
func (client BaseClient) CheckResourceName(ctx context.Context, resourceNameDefinition *ResourceName) (result CheckResourceNameResult, err error)
CheckResourceName a resource name is valid if it is not a reserved word, does not contains a reserved word and does not start with a reserved word Parameters: resourceNameDefinition - resource object with values for resource name and resource type
func (BaseClient) CheckResourceNamePreparer ¶
func (client BaseClient) CheckResourceNamePreparer(ctx context.Context, resourceNameDefinition *ResourceName) (*http.Request, error)
CheckResourceNamePreparer prepares the CheckResourceName request.
func (BaseClient) CheckResourceNameResponder ¶
func (client BaseClient) CheckResourceNameResponder(resp *http.Response) (result CheckResourceNameResult, err error)
CheckResourceNameResponder handles the response to the CheckResourceName request. The method always closes the http.Response Body.
func (BaseClient) CheckResourceNameSender ¶
CheckResourceNameSender sends the CheckResourceName request. The method will close the http.Response Body if it receives an error.
type CheckResourceNameResult ¶
type CheckResourceNameResult struct { autorest.Response `json:"-"` // Name - Name of Resource Name *string `json:"name,omitempty"` // Type - Type of Resource Type *string `json:"type,omitempty"` // Status - Is the resource name Allowed or Reserved. Possible values include: 'Allowed', 'Reserved' Status ResourceNameStatus `json:"status,omitempty"` }
CheckResourceNameResult resource Name valid if not a reserved word, does not contain a reserved word and does not start with a reserved word
type Client ¶
type Client struct {
BaseClient
}
Client is the client for the Subscriptions methods of the Subscriptions service.
func NewClientWithBaseURI ¶
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) Get ¶
func (client Client) Get(ctx context.Context, subscriptionID string) (result Subscription, err error)
Get gets details about particular subscription. Parameters: subscriptionID - id of the subscription.
func (Client) GetPreparer ¶
GetPreparer prepares the Get request.
func (Client) GetResponder ¶
func (client Client) GetResponder(resp *http.Response) (result Subscription, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (Client) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (Client) List ¶
func (client Client) List(ctx context.Context) (result ListResultPage, err error)
List gets a list of the subscriptionIds.
func (Client) ListComplete ¶
func (client Client) ListComplete(ctx context.Context) (result ListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (Client) ListLocations ¶
func (client Client) ListLocations(ctx context.Context, subscriptionID string) (result LocationListResult, err error)
ListLocations gets a list of the subscription locations. Parameters: subscriptionID - id of the subscription
func (Client) ListLocationsPreparer ¶
func (client Client) ListLocationsPreparer(ctx context.Context, subscriptionID string) (*http.Request, error)
ListLocationsPreparer prepares the ListLocations request.
func (Client) ListLocationsResponder ¶
func (client Client) ListLocationsResponder(resp *http.Response) (result LocationListResult, err error)
ListLocationsResponder handles the response to the ListLocations request. The method always closes the http.Response Body.
func (Client) ListLocationsSender ¶
ListLocationsSender sends the ListLocations request. The method will close the http.Response Body if it receives an error.
func (Client) ListPreparer ¶
ListPreparer prepares the List request.
func (Client) ListResponder ¶
func (client Client) ListResponder(resp *http.Response) (result ListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
type ErrorDefinition ¶
type ErrorDefinition struct { // Message - Description of the error. Message *string `json:"message,omitempty"` // Code - Code of the error. Code *string `json:"code,omitempty"` }
ErrorDefinition error description and code explaining why resource name is invalid.
type ErrorResponse ¶
type ErrorResponse struct { // Error - The error details. Error *ErrorDefinition `json:"error,omitempty"` }
ErrorResponse error response.
type ListResult ¶
type ListResult struct { autorest.Response `json:"-"` // Value - Gets or sets subscriptions. Value *[]Subscription `json:"value,omitempty"` // NextLink - Gets or sets the URL to get the next set of results. NextLink *string `json:"nextLink,omitempty"` }
ListResult subscription list operation response.
func (ListResult) IsEmpty ¶
func (lr ListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ListResultIterator ¶
type ListResultIterator struct {
// contains filtered or unexported fields
}
ListResultIterator provides access to a complete listing of Subscription values.
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() Subscription
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ListResultPage ¶
type ListResultPage struct {
// contains filtered or unexported fields
}
ListResultPage contains a page of Subscription values.
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() []Subscription
Values returns the slice of values for the current page or nil if there are no values.
type Location ¶
type Location struct { // ID - Gets or sets the ID of the resource (/subscriptions/SubscriptionId). ID *string `json:"id,omitempty"` // SubscriptionID - Gets or sets the subscription Id. SubscriptionID *string `json:"subscriptionId,omitempty"` // Name - Gets or sets the location name Name *string `json:"name,omitempty"` // DisplayName - Gets or sets the display name of the location DisplayName *string `json:"displayName,omitempty"` // Latitude - Gets or sets the latitude of the location Latitude *string `json:"latitude,omitempty"` // Longitude - Gets or sets the longitude of the location Longitude *string `json:"longitude,omitempty"` }
Location location information.
type LocationListResult ¶
type LocationListResult struct { autorest.Response `json:"-"` // Value - Gets the locations. Value *[]Location `json:"value,omitempty"` }
LocationListResult location list operation response.
type Policies ¶
type Policies struct { // LocationPlacementID - Gets or sets the subscription location placement Id. LocationPlacementID *string `json:"locationPlacementId,omitempty"` // QuotaID - Gets or sets the subscription quota Id. QuotaID *string `json:"quotaId,omitempty"` }
Policies subscription policies.
type ResourceName ¶
type ResourceName struct { // Name - Name of the resource Name *string `json:"name,omitempty"` // Type - The type of the resource Type *string `json:"type,omitempty"` }
ResourceName name and Type of the Resource
type ResourceNameStatus ¶
type ResourceNameStatus string
ResourceNameStatus enumerates the values for resource name status.
const ( // Allowed ... Allowed ResourceNameStatus = "Allowed" // Reserved ... Reserved ResourceNameStatus = "Reserved" )
func PossibleResourceNameStatusValues ¶
func PossibleResourceNameStatusValues() []ResourceNameStatus
PossibleResourceNameStatusValues returns an array of possible values for the ResourceNameStatus const type.
type Subscription ¶
type Subscription struct { autorest.Response `json:"-"` // ID - Gets or sets the ID of the resource (/subscriptions/SubscriptionId). ID *string `json:"id,omitempty"` // SubscriptionID - Gets or sets the subscription Id. SubscriptionID *string `json:"subscriptionId,omitempty"` // DisplayName - Gets or sets the subscription display name DisplayName *string `json:"displayName,omitempty"` // State - Gets or sets the subscription state State *string `json:"state,omitempty"` // SubscriptionPolicies - Gets or sets the subscription policies. SubscriptionPolicies *Policies `json:"subscriptionPolicies,omitempty"` }
Subscription subscription information.
type TenantIDDescription ¶
type TenantIDDescription struct { // ID - Gets or sets Id ID *string `json:"id,omitempty"` // TenantID - Gets or sets tenantId TenantID *string `json:"tenantId,omitempty"` }
TenantIDDescription tenant Id information
type TenantListResult ¶
type TenantListResult struct { autorest.Response `json:"-"` // Value - Gets or sets tenant Ids. Value *[]TenantIDDescription `json:"value,omitempty"` // NextLink - Gets or sets the URL to get the next set of results. NextLink *string `json:"nextLink,omitempty"` }
TenantListResult tenant Ids information.
func (TenantListResult) IsEmpty ¶
func (tlr TenantListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type TenantListResultIterator ¶
type TenantListResultIterator struct {
// contains filtered or unexported fields
}
TenantListResultIterator provides access to a complete listing of TenantIDDescription values.
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 ¶
type TenantListResultPage struct {
// contains filtered or unexported fields
}
TenantListResultPage contains a page of TenantIDDescription values.
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 ¶
type TenantsClient struct {
BaseClient
}
TenantsClient is the client for the Tenants methods of the Subscriptions service.
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 a list of the tenantIds.
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 ¶
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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.