const (
// DefaultBaseURI is the default URI used for the service Managementgroups
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.
AzureAsyncOperationResults the results of Azure-AsyncOperation.
type AzureAsyncOperationResults struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; The type of the resource. For example, Microsoft.Management/managementGroups
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; The name of the management group. For example, 00000000-0000-0000-0000-000000000000
Name *string `json:"name,omitempty"`
// Status - READ-ONLY; The current status of the asynchronous operation performed . For example, Running, Succeeded, Failed
Status *string `json:"status,omitempty"`
*InfoProperties `json:"properties,omitempty"`
}
func (aaor AzureAsyncOperationResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AzureAsyncOperationResults.
func (aaor *AzureAsyncOperationResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AzureAsyncOperationResults struct.
BaseClient is the base client for Managementgroups.
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) CheckNameAvailability(ctx context.Context, checkNameAvailabilityRequest CheckNameAvailabilityRequest) (result CheckNameAvailabilityResult, err error)
CheckNameAvailability checks if the specified management group name is valid and unique Parameters: checkNameAvailabilityRequest - management group name availability check parameters.
func (client BaseClient) CheckNameAvailabilityPreparer(ctx context.Context, checkNameAvailabilityRequest CheckNameAvailabilityRequest) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
func (client BaseClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityResult, err error)
CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.
func (client BaseClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) StartTenantBackfill(ctx context.Context) (result TenantBackfillStatusResult, err error)
StartTenantBackfill starts backfilling subscriptions for the Tenant.
func (client BaseClient) StartTenantBackfillPreparer(ctx context.Context) (*http.Request, error)
StartTenantBackfillPreparer prepares the StartTenantBackfill request.
func (client BaseClient) StartTenantBackfillResponder(resp *http.Response) (result TenantBackfillStatusResult, err error)
StartTenantBackfillResponder handles the response to the StartTenantBackfill request. The method always closes the http.Response Body.
func (client BaseClient) StartTenantBackfillSender(req *http.Request) (*http.Response, error)
StartTenantBackfillSender sends the StartTenantBackfill request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) TenantBackfillStatus(ctx context.Context) (result TenantBackfillStatusResult, err error)
TenantBackfillStatus gets tenant backfill status
func (client BaseClient) TenantBackfillStatusPreparer(ctx context.Context) (*http.Request, error)
TenantBackfillStatusPreparer prepares the TenantBackfillStatus request.
func (client BaseClient) TenantBackfillStatusResponder(resp *http.Response) (result TenantBackfillStatusResult, err error)
TenantBackfillStatusResponder handles the response to the TenantBackfillStatus request. The method always closes the http.Response Body.
func (client BaseClient) TenantBackfillStatusSender(req *http.Request) (*http.Response, error)
TenantBackfillStatusSender sends the TenantBackfillStatus request. The method will close the http.Response Body if it receives an error.
CheckNameAvailabilityRequest management group name availability check parameters.
type CheckNameAvailabilityRequest struct {
// Name - the name to check for availability
Name *string `json:"name,omitempty"`
// Type - fully qualified resource type which includes provider namespace. Possible values include: 'MicrosoftManagementmanagementGroups'
Type Type `json:"type,omitempty"`
}
CheckNameAvailabilityResult describes the result of the request to check management group name availability.
type CheckNameAvailabilityResult struct {
autorest.Response `json:"-"`
// NameAvailable - READ-ONLY; Required. True indicates name is valid and available. False indicates the name is invalid, unavailable, or both.
NameAvailable *bool `json:"nameAvailable,omitempty"`
// Reason - READ-ONLY; Required if nameAvailable == false. Invalid indicates the name provided does not match the resource provider's naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable. Possible values include: 'Invalid', 'AlreadyExists'
Reason Reason `json:"reason,omitempty"`
// Message - READ-ONLY; Required if nameAvailable == false. Localized. If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name.
Message *string `json:"message,omitempty"`
}
func (cnar CheckNameAvailabilityResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CheckNameAvailabilityResult.
ChildInfo the child information of a management group.
type ChildInfo struct {
// Type - The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups). Possible values include: 'Type1MicrosoftManagementmanagementGroups', 'Type1Subscriptions'
Type Type1 `json:"type,omitempty"`
// ID - The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
ID *string `json:"id,omitempty"`
// Name - The name of the child entity.
Name *string `json:"name,omitempty"`
// DisplayName - The friendly name of the child resource.
DisplayName *string `json:"displayName,omitempty"`
// Roles - The roles definitions associated with the management group.
Roles *[]string `json:"roles,omitempty"`
// Children - The list of children.
Children *[]ChildInfo `json:"children,omitempty"`
}
Client is the the Azure Management Groups API enables consolidation of multiple subscriptions/resources into an organizational hierarchy and centrally manage access control, policies, alerting and reporting for those resources.
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) CreateOrUpdate(ctx context.Context, groupID string, createManagementGroupRequest CreateManagementGroupRequest, cacheControl string) (result CreateOrUpdateFuture, err error)
CreateOrUpdate create or update a management group. If a management group is already created and a subsequent create request is issued with different properties, the management group properties will be updated. Parameters: groupID - management Group ID. createManagementGroupRequest - management group creation parameters. cacheControl - indicates that the request shouldn't utilize any caches.
func (client Client) CreateOrUpdatePreparer(ctx context.Context, groupID string, createManagementGroupRequest CreateManagementGroupRequest, cacheControl string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client Client) CreateOrUpdateResponder(resp *http.Response) (result SetObject, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client Client) CreateOrUpdateSender(req *http.Request) (future CreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client Client) Delete(ctx context.Context, groupID string, cacheControl string) (result DeleteFuture, err error)
Delete delete management group. If a management group contains child resources, the request will fail. Parameters: groupID - management Group ID. cacheControl - indicates that the request shouldn't utilize any caches.
func (client Client) DeletePreparer(ctx context.Context, groupID string, cacheControl string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client Client) DeleteResponder(resp *http.Response) (result AzureAsyncOperationResults, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client Client) DeleteSender(req *http.Request) (future DeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client Client) Get(ctx context.Context, groupID string, expand string, recurse *bool, filter string, cacheControl string) (result ManagementGroup, err error)
Get get the details of the management group. Parameters: groupID - management Group ID. expand - the $expand=children query string parameter allows clients to request inclusion of children in the response payload. $expand=path includes the path from the root group to the current group. recurse - the $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload. Note that $expand=children must be passed up if $recurse is set to true. filter - a filter which allows the exclusion of subscriptions from results (i.e. '$filter=children.childType ne Subscription') cacheControl - indicates that the request shouldn't utilize any caches.
func (client Client) GetDescendants(ctx context.Context, groupID string, skiptoken string, top *int32) (result DescendantListResultPage, err error)
GetDescendants list all entities that descend from a management group. Parameters: groupID - management Group ID. skiptoken - page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls. top - number of elements to return when retrieving results. Passing this in will override $skipToken.
func (client Client) GetDescendantsComplete(ctx context.Context, groupID string, skiptoken string, top *int32) (result DescendantListResultIterator, err error)
GetDescendantsComplete enumerates all values, automatically crossing page boundaries as required.
func (client Client) GetDescendantsPreparer(ctx context.Context, groupID string, skiptoken string, top *int32) (*http.Request, error)
GetDescendantsPreparer prepares the GetDescendants request.
func (client Client) GetDescendantsResponder(resp *http.Response) (result DescendantListResult, err error)
GetDescendantsResponder handles the response to the GetDescendants request. The method always closes the http.Response Body.
func (client Client) GetDescendantsSender(req *http.Request) (*http.Response, error)
GetDescendantsSender sends the GetDescendants request. The method will close the http.Response Body if it receives an error.
func (client Client) GetPreparer(ctx context.Context, groupID string, expand string, recurse *bool, filter string, cacheControl string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client Client) GetResponder(resp *http.Response) (result ManagementGroup, 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, cacheControl string, skiptoken string) (result ListResultPage, err error)
List list management groups for the authenticated user. Parameters: cacheControl - indicates that the request shouldn't utilize any caches. skiptoken - page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.
func (client Client) ListComplete(ctx context.Context, cacheControl string, skiptoken string) (result ListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client Client) ListPreparer(ctx context.Context, cacheControl string, skiptoken string) (*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.
func (client Client) Update(ctx context.Context, groupID string, patchGroupRequest PatchManagementGroupRequest, cacheControl string) (result ManagementGroup, err error)
Update update a management group. Parameters: groupID - management Group ID. patchGroupRequest - management group patch parameters. cacheControl - indicates that the request shouldn't utilize any caches.
func (client Client) UpdatePreparer(ctx context.Context, groupID string, patchGroupRequest PatchManagementGroupRequest, cacheControl string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client Client) UpdateResponder(resp *http.Response) (result ManagementGroup, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client Client) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
CreateManagementGroupChildInfo the child information of a management group used during creation.
type CreateManagementGroupChildInfo struct {
// Type - READ-ONLY; The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups). Possible values include: 'Type2MicrosoftManagementmanagementGroups', 'Type2Subscriptions'
Type Type2 `json:"type,omitempty"`
// ID - READ-ONLY; The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the child entity.
Name *string `json:"name,omitempty"`
// DisplayName - READ-ONLY; The friendly name of the child resource.
DisplayName *string `json:"displayName,omitempty"`
// Roles - READ-ONLY; The roles definitions associated with the management group.
Roles *[]string `json:"roles,omitempty"`
// Children - READ-ONLY; The list of children.
Children *[]CreateManagementGroupChildInfo `json:"children,omitempty"`
}
func (cmgci CreateManagementGroupChildInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreateManagementGroupChildInfo.
CreateManagementGroupDetails the details of a management group used during creation.
type CreateManagementGroupDetails struct {
// Version - READ-ONLY; The version number of the object.
Version *float64 `json:"version,omitempty"`
// UpdatedTime - READ-ONLY; The date and time when this object was last updated.
UpdatedTime *date.Time `json:"updatedTime,omitempty"`
// UpdatedBy - READ-ONLY; The identity of the principal or process that updated the object.
UpdatedBy *string `json:"updatedBy,omitempty"`
Parent *CreateParentGroupInfo `json:"parent,omitempty"`
}
func (cmgd CreateManagementGroupDetails) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreateManagementGroupDetails.
CreateManagementGroupProperties the generic properties of a management group used during creation.
type CreateManagementGroupProperties struct {
// TenantID - READ-ONLY; The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
TenantID *string `json:"tenantId,omitempty"`
// DisplayName - The friendly name of the management group. If no value is passed then this field will be set to the groupId.
DisplayName *string `json:"displayName,omitempty"`
// Roles - READ-ONLY; The roles definitions associated with the management group.
Roles *[]string `json:"roles,omitempty"`
Details *CreateManagementGroupDetails `json:"details,omitempty"`
// Children - READ-ONLY; The list of children.
Children *[]CreateManagementGroupChildInfo `json:"children,omitempty"`
}
func (cmgp CreateManagementGroupProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreateManagementGroupProperties.
CreateManagementGroupRequest management group creation parameters.
type CreateManagementGroupRequest struct {
// ID - READ-ONLY; The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; The type of the resource. For example, Microsoft.Management/managementGroups
Type *string `json:"type,omitempty"`
// Name - The name of the management group. For example, 00000000-0000-0000-0000-000000000000
Name *string `json:"name,omitempty"`
*CreateManagementGroupProperties `json:"properties,omitempty"`
}
func (cmgr CreateManagementGroupRequest) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreateManagementGroupRequest.
func (cmgr *CreateManagementGroupRequest) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CreateManagementGroupRequest struct.
CreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CreateOrUpdateFuture 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) (SetObject, error)
}
func (future *CreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CreateOrUpdateSettingsProperties the properties of the request to create or update Management Group settings
type CreateOrUpdateSettingsProperties struct {
// RequireAuthorizationForGroupCreation - Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access.
RequireAuthorizationForGroupCreation *bool `json:"requireAuthorizationForGroupCreation,omitempty"`
// DefaultManagementGroup - Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup
DefaultManagementGroup *string `json:"defaultManagementGroup,omitempty"`
}
CreateOrUpdateSettingsRequest parameters for creating or updating Management Group settings
type CreateOrUpdateSettingsRequest struct {
*CreateOrUpdateSettingsProperties `json:"properties,omitempty"`
}
func (cousr CreateOrUpdateSettingsRequest) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreateOrUpdateSettingsRequest.
func (cousr *CreateOrUpdateSettingsRequest) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CreateOrUpdateSettingsRequest struct.
CreateParentGroupInfo (Optional) The ID of the parent management group used during creation.
type CreateParentGroupInfo struct {
// ID - The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the parent management group
Name *string `json:"name,omitempty"`
// DisplayName - READ-ONLY; The friendly name of the parent management group.
DisplayName *string `json:"displayName,omitempty"`
}
func (cpgi CreateParentGroupInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreateParentGroupInfo.
DeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DeleteFuture 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) (AzureAsyncOperationResults, error)
}
func (future *DeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DescendantInfo the descendant.
type DescendantInfo struct {
// ID - READ-ONLY; The fully qualified ID for the descendant. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 or /subscriptions/0000000-0000-0000-0000-000000000000
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; The type of the resource. For example, Microsoft.Management/managementGroups or /subscriptions
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; The name of the descendant. For example, 00000000-0000-0000-0000-000000000000
Name *string `json:"name,omitempty"`
*DescendantInfoProperties `json:"properties,omitempty"`
}
func (di DescendantInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DescendantInfo.
func (di *DescendantInfo) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DescendantInfo struct.
DescendantInfoProperties the generic properties of an descendant.
type DescendantInfoProperties struct {
// DisplayName - The friendly name of the management group.
DisplayName *string `json:"displayName,omitempty"`
Parent *DescendantParentGroupInfo `json:"parent,omitempty"`
}
DescendantListResult describes the result of the request to view descendants.
type DescendantListResult struct {
autorest.Response `json:"-"`
// Value - The list of descendants.
Value *[]DescendantInfo `json:"value,omitempty"`
// NextLink - READ-ONLY; The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (dlr DescendantListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (dlr DescendantListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DescendantListResult.
DescendantListResultIterator provides access to a complete listing of DescendantInfo values.
type DescendantListResultIterator struct {
// contains filtered or unexported fields
}
func NewDescendantListResultIterator(page DescendantListResultPage) DescendantListResultIterator
Creates a new instance of the DescendantListResultIterator type.
func (iter *DescendantListResultIterator) 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 *DescendantListResultIterator) 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 DescendantListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DescendantListResultIterator) Response() DescendantListResult
Response returns the raw server response from the last page request.
func (iter DescendantListResultIterator) Value() DescendantInfo
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
DescendantListResultPage contains a page of DescendantInfo values.
type DescendantListResultPage struct {
// contains filtered or unexported fields
}
func NewDescendantListResultPage(cur DescendantListResult, getNextPage func(context.Context, DescendantListResult) (DescendantListResult, error)) DescendantListResultPage
Creates a new instance of the DescendantListResultPage type.
func (page *DescendantListResultPage) 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 *DescendantListResultPage) 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 DescendantListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DescendantListResultPage) Response() DescendantListResult
Response returns the raw server response from the last page request.
func (page DescendantListResultPage) Values() []DescendantInfo
Values returns the slice of values for the current page or nil if there are no values.
DescendantParentGroupInfo the ID of the parent management group.
type DescendantParentGroupInfo struct {
// ID - The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
ID *string `json:"id,omitempty"`
}
Details the details of a management group.
type Details struct {
// Version - The version number of the object.
Version *float64 `json:"version,omitempty"`
// UpdatedTime - The date and time when this object was last updated.
UpdatedTime *date.Time `json:"updatedTime,omitempty"`
// UpdatedBy - The identity of the principal or process that updated the object.
UpdatedBy *string `json:"updatedBy,omitempty"`
Parent *ParentGroupInfo `json:"parent,omitempty"`
}
EntitiesClient is the the Azure Management Groups API enables consolidation of multiple subscriptions/resources into an organizational hierarchy and centrally manage access control, policies, alerting and reporting for those resources.
type EntitiesClient struct {
BaseClient
}
func NewEntitiesClient() EntitiesClient
NewEntitiesClient creates an instance of the EntitiesClient client.
func NewEntitiesClientWithBaseURI(baseURI string) EntitiesClient
NewEntitiesClientWithBaseURI creates an instance of the EntitiesClient 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 EntitiesClient) List(ctx context.Context, skiptoken string, skip *int32, top *int32, selectParameter string, search string, filter string, view string, groupName string, cacheControl string) (result EntityListResultPage, err error)
List list all entities (Management Groups, Subscriptions, etc.) for the authenticated user. Parameters: skiptoken - page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls. skip - number of entities to skip over when retrieving results. Passing this in will override $skipToken. top - number of elements to return when retrieving results. Passing this in will override $skipToken. selectParameter - this parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken. search - the $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions. With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity. With $search=ParentAndFirstLevelChildren the API will return the parent and first level of children that the user has either direct access to or indirect access via one of their descendants. With $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group. With $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter. The user must have direct access to the children entities or one of it's descendants for it to show up in the results. filter - the filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}') and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively. view - the view parameter allows clients to filter the type of data that is returned by the getEntities call. groupName - a filter which allows the get entities call to focus on a particular group (i.e. "$filter=name eq 'groupName'") cacheControl - indicates that the request shouldn't utilize any caches.
func (client EntitiesClient) ListComplete(ctx context.Context, skiptoken string, skip *int32, top *int32, selectParameter string, search string, filter string, view string, groupName string, cacheControl string) (result EntityListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client EntitiesClient) ListPreparer(ctx context.Context, skiptoken string, skip *int32, top *int32, selectParameter string, search string, filter string, view string, groupName string, cacheControl string) (*http.Request, error)
ListPreparer prepares the List request.
func (client EntitiesClient) ListResponder(resp *http.Response) (result EntityListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client EntitiesClient) 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.
EntityHierarchyItem the management group details for the hierarchy view.
type EntityHierarchyItem struct {
// ID - READ-ONLY; The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; The type of the resource. For example, Microsoft.Management/managementGroups
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; The name of the management group. For example, 00000000-0000-0000-0000-000000000000
Name *string `json:"name,omitempty"`
*EntityHierarchyItemProperties `json:"properties,omitempty"`
}
func (ehi EntityHierarchyItem) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EntityHierarchyItem.
func (ehi *EntityHierarchyItem) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for EntityHierarchyItem struct.
EntityHierarchyItemProperties the generic properties of a management group.
type EntityHierarchyItemProperties struct {
// DisplayName - The friendly name of the management group.
DisplayName *string `json:"displayName,omitempty"`
// Permissions - Possible values include: 'Permissions1Noaccess', 'Permissions1View', 'Permissions1Edit', 'Permissions1Delete'
Permissions Permissions1 `json:"permissions,omitempty"`
// Children - The list of children.
Children *[]EntityHierarchyItem `json:"children,omitempty"`
}
EntityInfo the entity.
type EntityInfo struct {
// ID - READ-ONLY; The fully qualified ID for the entity. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; The type of the resource. For example, Microsoft.Management/managementGroups
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; The name of the entity. For example, 00000000-0000-0000-0000-000000000000
Name *string `json:"name,omitempty"`
*EntityInfoProperties `json:"properties,omitempty"`
}
func (ei EntityInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EntityInfo.
func (ei *EntityInfo) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for EntityInfo struct.
EntityInfoProperties the generic properties of an entity.
type EntityInfoProperties struct {
// TenantID - The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000
TenantID *string `json:"tenantId,omitempty"`
// DisplayName - The friendly name of the management group.
DisplayName *string `json:"displayName,omitempty"`
Parent *EntityParentGroupInfo `json:"parent,omitempty"`
// Permissions - Possible values include: 'PermissionsNoaccess', 'PermissionsView', 'PermissionsEdit', 'PermissionsDelete'
Permissions Permissions `json:"permissions,omitempty"`
// InheritedPermissions - Possible values include: 'Noaccess', 'View', 'Edit', 'Delete'
InheritedPermissions InheritedPermissions `json:"inheritedPermissions,omitempty"`
NumberOfDescendants *int32 `json:"numberOfDescendants,omitempty"`
// NumberOfChildren - Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group.
NumberOfChildren *int32 `json:"numberOfChildren,omitempty"`
// NumberOfChildGroups - Number of children is the number of Groups that are exactly one level underneath the current Group.
NumberOfChildGroups *int32 `json:"numberOfChildGroups,omitempty"`
// ParentDisplayNameChain - The parent display name chain from the root group to the immediate parent
ParentDisplayNameChain *[]string `json:"parentDisplayNameChain,omitempty"`
// ParentNameChain - The parent name chain from the root group to the immediate parent
ParentNameChain *[]string `json:"parentNameChain,omitempty"`
}
EntityListResult describes the result of the request to view entities.
type EntityListResult struct {
autorest.Response `json:"-"`
// Value - The list of entities.
Value *[]EntityInfo `json:"value,omitempty"`
// Count - READ-ONLY; Total count of records that match the filter
Count *int32 `json:"count,omitempty"`
// NextLink - READ-ONLY; The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (elr EntityListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (elr EntityListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EntityListResult.
EntityListResultIterator provides access to a complete listing of EntityInfo values.
type EntityListResultIterator struct {
// contains filtered or unexported fields
}
func NewEntityListResultIterator(page EntityListResultPage) EntityListResultIterator
Creates a new instance of the EntityListResultIterator type.
func (iter *EntityListResultIterator) 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 *EntityListResultIterator) 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 EntityListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter EntityListResultIterator) Response() EntityListResult
Response returns the raw server response from the last page request.
func (iter EntityListResultIterator) Value() EntityInfo
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
EntityListResultPage contains a page of EntityInfo values.
type EntityListResultPage struct {
// contains filtered or unexported fields
}
func NewEntityListResultPage(cur EntityListResult, getNextPage func(context.Context, EntityListResult) (EntityListResult, error)) EntityListResultPage
Creates a new instance of the EntityListResultPage type.
func (page *EntityListResultPage) 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 *EntityListResultPage) 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 EntityListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page EntityListResultPage) Response() EntityListResult
Response returns the raw server response from the last page request.
func (page EntityListResultPage) Values() []EntityInfo
Values returns the slice of values for the current page or nil if there are no values.
EntityParentGroupInfo (Optional) The ID of the parent management group.
type EntityParentGroupInfo struct {
// ID - The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
ID *string `json:"id,omitempty"`
}
ErrorDetails the details of the error.
type ErrorDetails struct {
// Code - One of a server-defined set of error codes.
Code *string `json:"code,omitempty"`
// Message - A human-readable representation of the error.
Message *string `json:"message,omitempty"`
// Details - A human-readable representation of the error's details.
Details *string `json:"details,omitempty"`
}
ErrorResponse the error object.
type ErrorResponse struct {
Error *ErrorDetails `json:"error,omitempty"`
}
HierarchySettings settings defined at the Management Group scope.
type HierarchySettings struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; The fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; The type of the resource. For example, Microsoft.Management/managementGroups/settings.
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; The name of the object. In this case, default.
Name *string `json:"name,omitempty"`
*HierarchySettingsProperties `json:"properties,omitempty"`
}
func (hs HierarchySettings) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for HierarchySettings.
func (hs *HierarchySettings) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for HierarchySettings struct.
HierarchySettingsClient is the the Azure Management Groups API enables consolidation of multiple subscriptions/resources into an organizational hierarchy and centrally manage access control, policies, alerting and reporting for those resources.
type HierarchySettingsClient struct {
BaseClient
}
func NewHierarchySettingsClient() HierarchySettingsClient
NewHierarchySettingsClient creates an instance of the HierarchySettingsClient client.
func NewHierarchySettingsClientWithBaseURI(baseURI string) HierarchySettingsClient
NewHierarchySettingsClientWithBaseURI creates an instance of the HierarchySettingsClient 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 HierarchySettingsClient) CreateOrUpdate(ctx context.Context, groupID string, createTenantSettingsRequest CreateOrUpdateSettingsRequest) (result HierarchySettings, err error)
CreateOrUpdate creates or updates the hierarchy settings defined at the Management Group level. Parameters: groupID - management Group ID. createTenantSettingsRequest - tenant level settings request parameter.
func (client HierarchySettingsClient) CreateOrUpdatePreparer(ctx context.Context, groupID string, createTenantSettingsRequest CreateOrUpdateSettingsRequest) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client HierarchySettingsClient) CreateOrUpdateResponder(resp *http.Response) (result HierarchySettings, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client HierarchySettingsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client HierarchySettingsClient) Delete(ctx context.Context, groupID string) (result autorest.Response, err error)
Delete deletes the hierarchy settings defined at the Management Group level. Parameters: groupID - management Group ID.
func (client HierarchySettingsClient) DeletePreparer(ctx context.Context, groupID string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client HierarchySettingsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client HierarchySettingsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client HierarchySettingsClient) Get(ctx context.Context, groupID string) (result HierarchySettings, err error)
Get gets the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy. Parameters: groupID - management Group ID.
func (client HierarchySettingsClient) GetPreparer(ctx context.Context, groupID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client HierarchySettingsClient) GetResponder(resp *http.Response) (result HierarchySettings, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client HierarchySettingsClient) 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 HierarchySettingsClient) List(ctx context.Context, groupID string) (result HierarchySettingsList, err error)
List gets all the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy. Parameters: groupID - management Group ID.
func (client HierarchySettingsClient) ListPreparer(ctx context.Context, groupID string) (*http.Request, error)
ListPreparer prepares the List request.
func (client HierarchySettingsClient) ListResponder(resp *http.Response) (result HierarchySettingsList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client HierarchySettingsClient) 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.
func (client HierarchySettingsClient) Update(ctx context.Context, groupID string, createTenantSettingsRequest CreateOrUpdateSettingsRequest) (result HierarchySettings, err error)
Update updates the hierarchy settings defined at the Management Group level. Parameters: groupID - management Group ID. createTenantSettingsRequest - tenant level settings request parameter.
func (client HierarchySettingsClient) UpdatePreparer(ctx context.Context, groupID string, createTenantSettingsRequest CreateOrUpdateSettingsRequest) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client HierarchySettingsClient) UpdateResponder(resp *http.Response) (result HierarchySettings, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client HierarchySettingsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
HierarchySettingsInfo the hierarchy settings resource.
type HierarchySettingsInfo struct {
// ID - READ-ONLY; The fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; The type of the resource. For example, Microsoft.Management/managementGroups/settings.
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; The name of the object. In this case, default.
Name *string `json:"name,omitempty"`
*HierarchySettingsProperties `json:"properties,omitempty"`
}
func (hsi HierarchySettingsInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for HierarchySettingsInfo.
func (hsi *HierarchySettingsInfo) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for HierarchySettingsInfo struct.
HierarchySettingsList lists all hierarchy settings.
type HierarchySettingsList struct {
autorest.Response `json:"-"`
// Value - The list of hierarchy settings.
Value *[]HierarchySettingsInfo `json:"value,omitempty"`
// NextLink - READ-ONLY; The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (hsl HierarchySettingsList) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for HierarchySettingsList.
HierarchySettingsProperties the generic properties of hierarchy settings.
type HierarchySettingsProperties struct {
// TenantID - The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000
TenantID *string `json:"tenantId,omitempty"`
// RequireAuthorizationForGroupCreation - Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access.
RequireAuthorizationForGroupCreation *bool `json:"requireAuthorizationForGroupCreation,omitempty"`
// DefaultManagementGroup - Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup
DefaultManagementGroup *string `json:"defaultManagementGroup,omitempty"`
}
Info the management group resource.
type Info struct {
// ID - READ-ONLY; The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; The type of the resource. For example, Microsoft.Management/managementGroups
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; The name of the management group. For example, 00000000-0000-0000-0000-000000000000
Name *string `json:"name,omitempty"`
*InfoProperties `json:"properties,omitempty"`
}
func (i Info) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Info.
func (i *Info) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Info struct.
InfoProperties the generic properties of a management group.
type InfoProperties struct {
// TenantID - The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
TenantID *string `json:"tenantId,omitempty"`
// DisplayName - The friendly name of the management group.
DisplayName *string `json:"displayName,omitempty"`
}
InheritedPermissions enumerates the values for inherited permissions.
type InheritedPermissions string
const (
// Delete ...
Delete InheritedPermissions = "delete"
// Edit ...
Edit InheritedPermissions = "edit"
// Noaccess ...
Noaccess InheritedPermissions = "noaccess"
// View ...
View InheritedPermissions = "view"
)
func PossibleInheritedPermissionsValues() []InheritedPermissions
PossibleInheritedPermissionsValues returns an array of possible values for the InheritedPermissions const type.
ListResult describes the result of the request to list management groups.
type ListResult struct {
autorest.Response `json:"-"`
// Value - The list of management groups.
Value *[]Info `json:"value,omitempty"`
// NextLink - READ-ONLY; The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (lr ListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (lr ListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ListResult.
ListResultIterator provides access to a complete listing of Info 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() Info
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 Info 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() []Info
Values returns the slice of values for the current page or nil if there are no values.
ManagementGroup the management group details.
type ManagementGroup struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; The type of the resource. For example, Microsoft.Management/managementGroups
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; The name of the management group. For example, 00000000-0000-0000-0000-000000000000
Name *string `json:"name,omitempty"`
*Properties `json:"properties,omitempty"`
}
func (mg ManagementGroup) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ManagementGroup.
func (mg *ManagementGroup) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ManagementGroup struct.
Operation operation supported by the Microsoft.Management resource provider.
type Operation struct {
// Name - READ-ONLY; Operation name: {provider}/{resource}/{operation}.
Name *string `json:"name,omitempty"`
Display *OperationDisplayProperties `json:"display,omitempty"`
}
func (o Operation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Operation.
OperationDisplayProperties the object that represents the operation.
type OperationDisplayProperties struct {
// Provider - READ-ONLY; The name of the provider.
Provider *string `json:"provider,omitempty"`
// Resource - READ-ONLY; The resource on which the operation is performed.
Resource *string `json:"resource,omitempty"`
// Operation - READ-ONLY; The operation that can be performed.
Operation *string `json:"operation,omitempty"`
// Description - READ-ONLY; Operation description.
Description *string `json:"description,omitempty"`
}
func (odp OperationDisplayProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationDisplayProperties.
OperationListResult describes the result of the request to list Microsoft.Management operations.
type OperationListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of operations supported by the Microsoft.Management resource provider.
Value *[]Operation `json:"value,omitempty"`
// NextLink - READ-ONLY; 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.
func (olr OperationListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationListResult.
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.
OperationResults the results of an asynchronous operation.
type OperationResults struct {
// ID - READ-ONLY; The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; The type of the resource. For example, Microsoft.Management/managementGroups
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; The name of the management group. For example, 00000000-0000-0000-0000-000000000000
Name *string `json:"name,omitempty"`
*InfoProperties `json:"properties,omitempty"`
}
func (or OperationResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationResults.
func (or *OperationResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for OperationResults struct.
OperationsClient is the the Azure Management Groups API enables consolidation of multiple subscriptions/resources into an organizational hierarchy and centrally manage access control, policies, alerting and reporting for those resources.
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 Management 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.
ParentGroupInfo (Optional) The ID of the parent management group.
type ParentGroupInfo struct {
// ID - The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
ID *string `json:"id,omitempty"`
// Name - The name of the parent management group
Name *string `json:"name,omitempty"`
// DisplayName - The friendly name of the parent management group.
DisplayName *string `json:"displayName,omitempty"`
}
PatchManagementGroupRequest management group patch parameters.
type PatchManagementGroupRequest struct {
// DisplayName - The friendly name of the management group.
DisplayName *string `json:"displayName,omitempty"`
// ParentID - (Optional) The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
ParentID *string `json:"parentId,omitempty"`
}
PathElement a path element of a management group ancestors.
type PathElement struct {
// Name - The name of the group.
Name *string `json:"name,omitempty"`
// DisplayName - The friendly name of the group.
DisplayName *string `json:"displayName,omitempty"`
}
Permissions enumerates the values for permissions.
type Permissions string
const (
// PermissionsDelete ...
PermissionsDelete Permissions = "delete"
// PermissionsEdit ...
PermissionsEdit Permissions = "edit"
// PermissionsNoaccess ...
PermissionsNoaccess Permissions = "noaccess"
// PermissionsView ...
PermissionsView Permissions = "view"
)
func PossiblePermissionsValues() []Permissions
PossiblePermissionsValues returns an array of possible values for the Permissions const type.
Permissions1 enumerates the values for permissions 1.
type Permissions1 string
const (
// Permissions1Delete ...
Permissions1Delete Permissions1 = "delete"
// Permissions1Edit ...
Permissions1Edit Permissions1 = "edit"
// Permissions1Noaccess ...
Permissions1Noaccess Permissions1 = "noaccess"
// Permissions1View ...
Permissions1View Permissions1 = "view"
)
func PossiblePermissions1Values() []Permissions1
PossiblePermissions1Values returns an array of possible values for the Permissions1 const type.
Properties the generic properties of a management group.
type Properties struct {
// TenantID - The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
TenantID *string `json:"tenantId,omitempty"`
// DisplayName - The friendly name of the management group.
DisplayName *string `json:"displayName,omitempty"`
// Roles - The role definitions associated with the management group.
Roles *[]string `json:"roles,omitempty"`
Details *Details `json:"details,omitempty"`
// Children - The list of children.
Children *[]ChildInfo `json:"children,omitempty"`
// Path - The path from the root to the current group.
Path *[]PathElement `json:"path,omitempty"`
}
Reason enumerates the values for reason.
type Reason string
const (
// AlreadyExists ...
AlreadyExists Reason = "AlreadyExists"
// Invalid ...
Invalid Reason = "Invalid"
)
func PossibleReasonValues() []Reason
PossibleReasonValues returns an array of possible values for the Reason const type.
SetObject ...
type SetObject struct {
autorest.Response `json:"-"`
Value interface{} `json:"value,omitempty"`
}
Status enumerates the values for status.
type Status string
const (
// Cancelled ...
Cancelled Status = "Cancelled"
// Completed ...
Completed Status = "Completed"
// Failed ...
Failed Status = "Failed"
// NotStarted ...
NotStarted Status = "NotStarted"
// NotStartedButGroupsExist ...
NotStartedButGroupsExist Status = "NotStartedButGroupsExist"
// Started ...
Started Status = "Started"
)
func PossibleStatusValues() []Status
PossibleStatusValues returns an array of possible values for the Status const type.
SubscriptionsClient is the the Azure Management Groups API enables consolidation of multiple subscriptions/resources into an organizational hierarchy and centrally manage access control, policies, alerting and reporting for those resources.
type SubscriptionsClient struct {
BaseClient
}
func NewSubscriptionsClient() SubscriptionsClient
NewSubscriptionsClient creates an instance of the SubscriptionsClient client.
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 (client SubscriptionsClient) Create(ctx context.Context, groupID string, subscriptionID string, cacheControl string) (result autorest.Response, err error)
Create associates existing subscription with the management group. Parameters: groupID - management Group ID. subscriptionID - subscription ID. cacheControl - indicates that the request shouldn't utilize any caches.
func (client SubscriptionsClient) CreatePreparer(ctx context.Context, groupID string, subscriptionID string, cacheControl string) (*http.Request, error)
CreatePreparer prepares the Create request.
func (client SubscriptionsClient) CreateResponder(resp *http.Response) (result autorest.Response, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client SubscriptionsClient) CreateSender(req *http.Request) (*http.Response, error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (client SubscriptionsClient) Delete(ctx context.Context, groupID string, subscriptionID string, cacheControl string) (result autorest.Response, err error)
Delete de-associates subscription from the management group. Parameters: groupID - management Group ID. subscriptionID - subscription ID. cacheControl - indicates that the request shouldn't utilize any caches.
func (client SubscriptionsClient) DeletePreparer(ctx context.Context, groupID string, subscriptionID string, cacheControl string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client SubscriptionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client SubscriptionsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
TenantBackfillStatusResult the tenant backfill status
type TenantBackfillStatusResult struct {
autorest.Response `json:"-"`
// TenantID - READ-ONLY; The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
TenantID *string `json:"tenantId,omitempty"`
// Status - READ-ONLY; The status of the Tenant Backfill. Possible values include: 'NotStarted', 'NotStartedButGroupsExist', 'Started', 'Failed', 'Cancelled', 'Completed'
Status Status `json:"status,omitempty"`
}
func (tbsr TenantBackfillStatusResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TenantBackfillStatusResult.
Type enumerates the values for type.
type Type string
const (
// MicrosoftManagementmanagementGroups ...
MicrosoftManagementmanagementGroups Type = "Microsoft.Management/managementGroups"
)
func PossibleTypeValues() []Type
PossibleTypeValues returns an array of possible values for the Type const type.
Type1 enumerates the values for type 1.
type Type1 string
const (
// Type1MicrosoftManagementmanagementGroups ...
Type1MicrosoftManagementmanagementGroups Type1 = "Microsoft.Management/managementGroups"
// Type1Subscriptions ...
Type1Subscriptions Type1 = "/subscriptions"
)
func PossibleType1Values() []Type1
PossibleType1Values returns an array of possible values for the Type1 const type.
Type2 enumerates the values for type 2.
type Type2 string
const (
// Type2MicrosoftManagementmanagementGroups ...
Type2MicrosoftManagementmanagementGroups Type2 = "Microsoft.Management/managementGroups"
// Type2Subscriptions ...
Type2Subscriptions Type2 = "/subscriptions"
)
func PossibleType2Values() []Type2
PossibleType2Values returns an array of possible values for the Type2 const type.
| Name | Synopsis |
|---|---|
| .. | |
| managementgroupsapi | Deprecated: Please note, this package has been deprecated. |