Documentation ¶
Overview ¶
Package subscriptions implements the Azure ARM Subscriptions service API version 2019-06-01.
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.
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 ManagedByTenant
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationListResultIterator
- func (iter *OperationListResultIterator) Next() error
- func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter OperationListResultIterator) NotDone() bool
- func (iter OperationListResultIterator) Response() OperationListResult
- func (iter OperationListResultIterator) Value() Operation
- type OperationListResultPage
- func (page *OperationListResultPage) Next() error
- func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page OperationListResultPage) NotDone() bool
- func (page OperationListResultPage) Response() OperationListResult
- func (page OperationListResultPage) Values() []Operation
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, 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
- type ResourceName
- type ResourceNameStatus
- type SpendingLimit
- type State
- type Subscription
- type TenantCategory
- 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 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.
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 a specified subscription. Parameters: subscriptionID - the ID of the target 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 all subscriptions for a tenant.
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 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) 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 - An array of subscriptions. Value *[]Subscription `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 ¶
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 - 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 ¶
type LocationListResult struct { autorest.Response `json:"-"` // Value - An array of locations. Value *[]Location `json:"value,omitempty"` }
LocationListResult location list operation response.
type ManagedByTenant ¶
type ManagedByTenant struct { // TenantID - READ-ONLY; The tenant ID of the managing tenant. This is a GUID. TenantID *string `json:"tenantId,omitempty"` }
ManagedByTenant information about a tenant managing the subscription.
type 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"` }
Operation microsoft.Resources operation
type OperationDisplay ¶
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"` }
OperationDisplay the object that represents the operation.
type OperationListResult ¶
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"` }
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.
func (OperationListResult) IsEmpty ¶
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type OperationListResultIterator ¶
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
OperationListResultIterator provides access to a complete listing of Operation values.
func NewOperationListResultIterator ¶
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (*OperationListResultIterator) Next ¶
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 (*OperationListResultIterator) NextWithContext ¶
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 (OperationListResultIterator) NotDone ¶
func (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (OperationListResultIterator) Response ¶
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (OperationListResultIterator) Value ¶
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.
type OperationListResultPage ¶
type OperationListResultPage struct {
// contains filtered or unexported fields
}
OperationListResultPage contains a page of Operation values.
func NewOperationListResultPage ¶
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (*OperationListResultPage) Next ¶
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 (*OperationListResultPage) NextWithContext ¶
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 (OperationListResultPage) NotDone ¶
func (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (OperationListResultPage) Response ¶
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (OperationListResultPage) Values ¶
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
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.
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 OperationListResultPage, err error)
List lists all of the available Microsoft.Resources REST API operations.
func (OperationsClient) ListComplete ¶
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (OperationsClient) ListPreparer ¶
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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type 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"` }
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 SpendingLimit ¶
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 ¶
func PossibleSpendingLimitValues() []SpendingLimit
PossibleSpendingLimitValues returns an array of possible values for the SpendingLimit const type.
type State ¶
type State string
State enumerates the values for state.
func PossibleStateValues ¶
func PossibleStateValues() []State
PossibleStateValues returns an array of possible values for the State const type.
type Subscription ¶
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"` // TenantID - READ-ONLY; The subscription tenant ID. TenantID *string `json:"tenantId,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"` // ManagedByTenants - An array containing the tenants managing the subscription. ManagedByTenants *[]ManagedByTenant `json:"managedByTenants,omitempty"` }
Subscription subscription information.
func (Subscription) MarshalJSON ¶
func (s Subscription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Subscription.
type TenantCategory ¶
type TenantCategory string
TenantCategory enumerates the values for tenant category.
const ( // Home ... Home TenantCategory = "Home" // ManagedBy ... ManagedBy TenantCategory = "ManagedBy" // ProjectedBy ... ProjectedBy TenantCategory = "ProjectedBy" )
func PossibleTenantCategoryValues ¶
func PossibleTenantCategoryValues() []TenantCategory
PossibleTenantCategoryValues returns an array of possible values for the TenantCategory const type.
type TenantIDDescription ¶
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"` // TenantCategory - READ-ONLY; The tenant category. Possible values include: 'Home', 'ProjectedBy', 'ManagedBy' TenantCategory TenantCategory `json:"tenantCategory,omitempty"` // Country - READ-ONLY; Country/region name of the address for the tenant. Country *string `json:"country,omitempty"` // CountryCode - READ-ONLY; Country/region abbreviation for the tenant. CountryCode *string `json:"countryCode,omitempty"` // DisplayName - READ-ONLY; The display name of the tenant. DisplayName *string `json:"displayName,omitempty"` // Domains - READ-ONLY; The list of domains for the tenant. Domains *[]string `json:"domains,omitempty"` }
TenantIDDescription tenant Id information.
type TenantListResult ¶
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 ¶
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 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.
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 ¶
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.