managementgroupsapi

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/managementgroups/armmanagementgroups(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/managementgroups/armmanagementgroups). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Index

• type BaseClientAPI
• type ClientAPI
• type EntitiesClientAPI
• type HierarchySettingsClientAPI
• type OperationsClientAPI
• type SubscriptionsClientAPI

Types

type BaseClientAPI

type BaseClientAPI interface {
	CheckNameAvailability(ctx context.Context, checkNameAvailabilityRequest managementgroups.CheckNameAvailabilityRequest) (result managementgroups.CheckNameAvailabilityResult, err error)
	StartTenantBackfill(ctx context.Context) (result managementgroups.TenantBackfillStatusResult, err error)
	TenantBackfillStatus(ctx context.Context) (result managementgroups.TenantBackfillStatusResult, err error)
}

BaseClientAPI contains the set of methods on the BaseClient type.

type ClientAPI

type ClientAPI interface {
	CreateOrUpdate(ctx context.Context, groupID string, createManagementGroupRequest managementgroups.CreateManagementGroupRequest, cacheControl string) (result managementgroups.CreateOrUpdateFuture, err error)
	Delete(ctx context.Context, groupID string, cacheControl string) (result managementgroups.DeleteFuture, err error)
	Get(ctx context.Context, groupID string, expand string, recurse *bool, filter string, cacheControl string) (result managementgroups.ManagementGroup, err error)
	GetDescendants(ctx context.Context, groupID string, skiptoken string, top *int32) (result managementgroups.DescendantListResultPage, err error)
	GetDescendantsComplete(ctx context.Context, groupID string, skiptoken string, top *int32) (result managementgroups.DescendantListResultIterator, err error)
	List(ctx context.Context, cacheControl string, skiptoken string) (result managementgroups.ListResultPage, err error)
	ListComplete(ctx context.Context, cacheControl string, skiptoken string) (result managementgroups.ListResultIterator, err error)
	Update(ctx context.Context, groupID string, patchGroupRequest managementgroups.PatchManagementGroupRequest, cacheControl string) (result managementgroups.ManagementGroup, err error)
}

ClientAPI contains the set of methods on the Client type.

type EntitiesClientAPI

type EntitiesClientAPI interface {
	List(ctx context.Context, skiptoken string, skip *int32, top *int32, selectParameter string, search string, filter string, view string, groupName string, cacheControl string) (result managementgroups.EntityListResultPage, err error)
	ListComplete(ctx context.Context, skiptoken string, skip *int32, top *int32, selectParameter string, search string, filter string, view string, groupName string, cacheControl string) (result managementgroups.EntityListResultIterator, err error)
}

EntitiesClientAPI contains the set of methods on the EntitiesClient type.

type HierarchySettingsClientAPI

type HierarchySettingsClientAPI interface {
	CreateOrUpdate(ctx context.Context, groupID string, createTenantSettingsRequest managementgroups.CreateOrUpdateSettingsRequest) (result managementgroups.HierarchySettings, err error)
	Delete(ctx context.Context, groupID string) (result autorest.Response, err error)
	Get(ctx context.Context, groupID string) (result managementgroups.HierarchySettings, err error)
	List(ctx context.Context, groupID string) (result managementgroups.HierarchySettingsList, err error)
	Update(ctx context.Context, groupID string, createTenantSettingsRequest managementgroups.CreateOrUpdateSettingsRequest) (result managementgroups.HierarchySettings, err error)
}

HierarchySettingsClientAPI contains the set of methods on the HierarchySettingsClient type.

type OperationsClientAPI

type OperationsClientAPI interface {
	List(ctx context.Context) (result managementgroups.OperationListResultPage, err error)
	ListComplete(ctx context.Context) (result managementgroups.OperationListResultIterator, err error)
}

OperationsClientAPI contains the set of methods on the OperationsClient type.

type SubscriptionsClientAPI

type SubscriptionsClientAPI interface {
	Create(ctx context.Context, groupID string, subscriptionID string, cacheControl string) (result managementgroups.SubscriptionUnderManagementGroup, err error)
	Delete(ctx context.Context, groupID string, subscriptionID string, cacheControl string) (result autorest.Response, err error)
	GetSubscription(ctx context.Context, groupID string, subscriptionID string, cacheControl string) (result managementgroups.SubscriptionUnderManagementGroup, err error)
	GetSubscriptionsUnderManagementGroup(ctx context.Context, groupID string, skiptoken string) (result managementgroups.ListSubscriptionUnderManagementGroupPage, err error)
	GetSubscriptionsUnderManagementGroupComplete(ctx context.Context, groupID string, skiptoken string) (result managementgroups.ListSubscriptionUnderManagementGroupIterator, err error)
}

SubscriptionsClientAPI contains the set of methods on the SubscriptionsClient type.