const (
// DefaultBaseURI is the default URI used for the service Subscriptions
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
BaseClient is the base client for Subscriptions.
type BaseClient struct {
autorest.Client
BaseURI string
}
func New() BaseClient
New creates an instance of the BaseClient client.
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 (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 (client BaseClient) CheckResourceNamePreparer(ctx context.Context, resourceNameDefinition *ResourceName) (*http.Request, error)
CheckResourceNamePreparer prepares the CheckResourceName request.
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 (client BaseClient) CheckResourceNameSender(req *http.Request) (*http.Response, error)
CheckResourceNameSender sends the CheckResourceName request. The method will close the http.Response Body if it receives an error.
CheckResourceNameResult resource Name valid if not a reserved word, does not contain a reserved word and does not start with a reserved word
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"`
}
Client is the all resource groups and resources exist within subscriptions. These operation enable you get information about your subscriptions and tenants. A tenant is a dedicated instance of Azure Active Directory (Azure AD) for your organization.
type Client struct {
BaseClient
}
func NewClient() Client
NewClient creates an instance of the Client client.
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 Client) Get(ctx context.Context, subscriptionID string) (result Subscription, err error)
Get gets details about a specified subscription. Parameters: subscriptionID - the ID of the target subscription.
func (client Client) GetPreparer(ctx context.Context, subscriptionID string) (*http.Request, error)
GetPreparer prepares the Get request.
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 Client) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client Client) List(ctx context.Context) (result ListResultPage, err error)
List gets all subscriptions for a tenant.
func (client Client) ListComplete(ctx context.Context) (result ListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client Client) 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 (client Client) ListLocationsPreparer(ctx context.Context, subscriptionID string) (*http.Request, error)
ListLocationsPreparer prepares the ListLocations request.
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 Client) ListLocationsSender(req *http.Request) (*http.Response, error)
ListLocationsSender sends the ListLocations request. The method will close the http.Response Body if it receives an error.
func (client Client) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client Client) ListResponder(resp *http.Response) (result ListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client Client) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
ErrorDefinition error description and code explaining why resource name is invalid.
type ErrorDefinition struct {
// Message - Description of the error.
Message *string `json:"message,omitempty"`
// Code - Code of the error.
Code *string `json:"code,omitempty"`
}
ErrorResponse error response.
type ErrorResponse struct {
// Error - The error details.
Error *ErrorDefinition `json:"error,omitempty"`
}
ListResult subscription list operation response.
type ListResult struct {
autorest.Response `json:"-"`
// Value - An array of subscriptions.
Value *[]Subscription `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (lr ListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ListResultIterator provides access to a complete listing of Subscription values.
type ListResultIterator struct {
// contains filtered or unexported fields
}
func NewListResultIterator(page ListResultPage) ListResultIterator
Creates a new instance of the ListResultIterator type.
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 (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 (iter ListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListResultIterator) Response() ListResult
Response returns the raw server response from the last page request.
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.
ListResultPage contains a page of Subscription values.
type ListResultPage struct {
// contains filtered or unexported fields
}
func NewListResultPage(cur ListResult, getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage
Creates a new instance of the ListResultPage type.
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 (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 (page ListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListResultPage) Response() ListResult
Response returns the raw server response from the last page request.
func (page ListResultPage) Values() []Subscription
Values returns the slice of values for the current page or nil if there are no values.
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 (l Location) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Location.
LocationListResult location list operation response.
type LocationListResult struct {
autorest.Response `json:"-"`
// Value - An array of locations.
Value *[]Location `json:"value,omitempty"`
}
Operation microsoft.Resources 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"`
}
OperationDisplay the object that represents the operation.
type OperationDisplay struct {
// Provider - Service provider: Microsoft.Resources
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"`
// Description - Description of the operation.
Description *string `json:"description,omitempty"`
}
OperationListResult result of the request to list Microsoft.Resources 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 Microsoft.Resources 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"`
}
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
OperationListResultIterator provides access to a complete listing of Operation values.
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (iter *OperationListResultIterator) 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 (iter *OperationListResultIterator) 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 (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (iter OperationListResultIterator) Value() Operation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
OperationListResultPage contains a page of Operation values.
type OperationListResultPage struct {
// contains filtered or unexported fields
}
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (page *OperationListResultPage) 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 (page *OperationListResultPage) 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 (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
OperationsClient is the all resource groups and resources exist within subscriptions. These operation enable you get information about your subscriptions and tenants. A tenant is a dedicated instance of Azure Active Directory (Azure AD) for your organization.
type OperationsClient struct {
BaseClient
}
func NewOperationsClient() OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
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 (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all of the available Microsoft.Resources REST API operations.
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
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 (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.
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 (p Policies) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Policies.
ResourceName name and Type of the Resource
type ResourceName struct {
// Name - Name of the resource
Name *string `json:"name,omitempty"`
// Type - The type of the resource
Type *string `json:"type,omitempty"`
}
ResourceNameStatus enumerates the values for resource name status.
type ResourceNameStatus string
const (
// Allowed ...
Allowed ResourceNameStatus = "Allowed"
// Reserved ...
Reserved ResourceNameStatus = "Reserved"
)
func PossibleResourceNameStatusValues() []ResourceNameStatus
PossibleResourceNameStatusValues returns an array of possible values for the ResourceNameStatus const type.
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() []SpendingLimit
PossibleSpendingLimitValues returns an array of possible values for the SpendingLimit const type.
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() []State
PossibleStateValues returns an array of possible values for the State const type.
Subscription subscription information.
type Subscription 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 (s Subscription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Subscription.
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 (tid TenantIDDescription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TenantIDDescription.
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 (tlr TenantListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
TenantListResultIterator provides access to a complete listing of TenantIDDescription values.
type TenantListResultIterator struct {
// contains filtered or unexported fields
}
func NewTenantListResultIterator(page TenantListResultPage) TenantListResultIterator
Creates a new instance of the TenantListResultIterator type.
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 (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 (iter TenantListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter TenantListResultIterator) Response() TenantListResult
Response returns the raw server response from the last page request.
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.
TenantListResultPage contains a page of TenantIDDescription values.
type TenantListResultPage struct {
// contains filtered or unexported fields
}
func NewTenantListResultPage(cur TenantListResult, getNextPage func(context.Context, TenantListResult) (TenantListResult, error)) TenantListResultPage
Creates a new instance of the TenantListResultPage type.
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 (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 (page TenantListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page TenantListResultPage) Response() TenantListResult
Response returns the raw server response from the last page request.
func (page TenantListResultPage) Values() []TenantIDDescription
Values returns the slice of values for the current page or nil if there are no values.
TenantsClient is the all resource groups and resources exist within subscriptions. These operation enable you get information about your subscriptions and tenants. A tenant is a dedicated instance of Azure Active Directory (Azure AD) for your organization.
type TenantsClient struct {
BaseClient
}
func NewTenantsClient() TenantsClient
NewTenantsClient creates an instance of the TenantsClient client.
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 (client TenantsClient) List(ctx context.Context) (result TenantListResultPage, err error)
List gets the tenants for your account.
func (client TenantsClient) ListComplete(ctx context.Context) (result TenantListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client TenantsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
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 (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.
| Name | Synopsis |
|---|---|
| .. | |
| subscriptionsapi | Deprecated: Please note, this package has been deprecated. |