managementgroups

package
v50.1.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 15, 2021 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package managementgroups implements the Azure ARM Managementgroups service API version 2018-01-01-preview.

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.

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Managementgroups
	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

type BaseClient struct {
	autorest.Client
	BaseURI           string
	OperationResultID string
	Skiptoken         string
}

BaseClient is the base client for Managementgroups.

func New

func New(operationResultID string, skiptoken string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, operationResultID string, skiptoken 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) CheckNameAvailability

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 (BaseClient) CheckNameAvailabilityPreparer

func (client BaseClient) CheckNameAvailabilityPreparer(ctx context.Context, checkNameAvailabilityRequest CheckNameAvailabilityRequest) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (BaseClient) CheckNameAvailabilityResponder

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 (BaseClient) CheckNameAvailabilitySender

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.

type CheckNameAvailabilityRequest

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: 'ProvidersMicrosoftManagementmanagementGroups'
	Type Type `json:"type,omitempty"`
}

CheckNameAvailabilityRequest management group name availability check parameters.

type CheckNameAvailabilityResult

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"`
}

CheckNameAvailabilityResult describes the result of the request to check management group name availability.

type ChildInfo

type ChildInfo struct {
	// Type - The fully qualified resource type which includes provider namespace (e.g. /providers/Microsoft.Management/managementGroups). Possible values include: 'Type1ProvidersMicrosoftManagementmanagementGroups', '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"`
}

ChildInfo the child information of a management group.

type Client

type Client struct {
	BaseClient
}

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.

func NewClient

func NewClient(operationResultID string, skiptoken string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI

func NewClientWithBaseURI(baseURI string, operationResultID string, skiptoken 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) CreateOrUpdate

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) CreateOrUpdatePreparer

func (client Client) CreateOrUpdatePreparer(ctx context.Context, groupID string, createManagementGroupRequest CreateManagementGroupRequest, cacheControl string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (Client) CreateOrUpdateResponder

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) CreateOrUpdateSender

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) Delete

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) DeletePreparer

func (client Client) DeletePreparer(ctx context.Context, groupID string, cacheControl string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (Client) DeleteResponder

func (client Client) DeleteResponder(resp *http.Response) (result OperationResults, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (Client) DeleteSender

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) Get

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. 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) GetPreparer

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) GetResponder

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) GetSender

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) List

func (client Client) List(ctx context.Context, cacheControl string) (result ListResultPage, err error)

List list management groups for the authenticated user. Parameters: cacheControl - indicates that the request shouldn't utilize any caches.

func (Client) ListComplete

func (client Client) ListComplete(ctx context.Context, cacheControl string) (result ListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListPreparer

func (client Client) ListPreparer(ctx context.Context, cacheControl string) (*http.Request, error)

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.

func (Client) ListSender

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) Update

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) UpdatePreparer

func (client Client) UpdatePreparer(ctx context.Context, groupID string, patchGroupRequest PatchManagementGroupRequest, cacheControl string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (Client) UpdateResponder

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) UpdateSender

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.

type CreateManagementGroupChildInfo

type CreateManagementGroupChildInfo struct {
	// Type - READ-ONLY; The fully qualified resource type which includes provider namespace (e.g. /providers/Microsoft.Management/managementGroups). Possible values include: 'Type2ProvidersMicrosoftManagementmanagementGroups', '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"`
}

CreateManagementGroupChildInfo the child information of a management group used during creation.

type CreateManagementGroupDetails

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"`
}

CreateManagementGroupDetails the details of a management group used during creation.

func (CreateManagementGroupDetails) MarshalJSON

func (cmgd CreateManagementGroupDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateManagementGroupDetails.

type CreateManagementGroupProperties

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"`
}

CreateManagementGroupProperties the generic properties of a management group used during creation.

func (CreateManagementGroupProperties) MarshalJSON

func (cmgp CreateManagementGroupProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateManagementGroupProperties.

type CreateManagementGroupRequest

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, /providers/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"`
}

CreateManagementGroupRequest management group creation parameters.

func (CreateManagementGroupRequest) MarshalJSON

func (cmgr CreateManagementGroupRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateManagementGroupRequest.

func (*CreateManagementGroupRequest) UnmarshalJSON

func (cmgr *CreateManagementGroupRequest) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CreateManagementGroupRequest struct.

type CreateOrUpdateFuture

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)
}

CreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type CreateParentGroupInfo

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"`
}

CreateParentGroupInfo (Optional) The ID of the parent management group used during creation.

func (CreateParentGroupInfo) MarshalJSON

func (cpgi CreateParentGroupInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateParentGroupInfo.

type DeleteFuture

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) (OperationResults, error)
}

DeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type Details

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"`
}

Details the details of a management group.

type EntitiesClient

type EntitiesClient struct {
	BaseClient
}

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.

func NewEntitiesClient

func NewEntitiesClient(operationResultID string, skiptoken string) EntitiesClient

NewEntitiesClient creates an instance of the EntitiesClient client.

func NewEntitiesClientWithBaseURI

func NewEntitiesClientWithBaseURI(baseURI string, operationResultID string, skiptoken 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 (EntitiesClient) List

func (client EntitiesClient) List(ctx context.Context, groupName string, cacheControl string) (result EntityListResultPage, err error)

List list all entities (Management Groups, Subscriptions, etc.) for the authenticated user. Parameters: groupName - a filter which allows the call to be filtered for a specific group. cacheControl - indicates that the request shouldn't utilize any caches.

func (EntitiesClient) ListComplete

func (client EntitiesClient) ListComplete(ctx context.Context, groupName string, cacheControl string) (result EntityListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (EntitiesClient) ListPreparer

func (client EntitiesClient) ListPreparer(ctx context.Context, groupName string, cacheControl string) (*http.Request, error)

ListPreparer prepares the List request.

func (EntitiesClient) ListResponder

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 (EntitiesClient) ListSender

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.

type EntityHierarchyItem

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, /providers/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"`
}

EntityHierarchyItem the management group details for the hierarchy view.

func (EntityHierarchyItem) MarshalJSON

func (ehi EntityHierarchyItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EntityHierarchyItem.

func (*EntityHierarchyItem) UnmarshalJSON

func (ehi *EntityHierarchyItem) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EntityHierarchyItem struct.

type EntityHierarchyItemProperties

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"`
}

EntityHierarchyItemProperties the generic properties of a management group.

type EntityInfo

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, /providers/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"`
}

EntityInfo the entity.

func (EntityInfo) MarshalJSON

func (ei EntityInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EntityInfo.

func (*EntityInfo) UnmarshalJSON

func (ei *EntityInfo) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EntityInfo struct.

type EntityInfoProperties

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: 'Noaccess', 'View', 'Edit', 'Delete'
	Permissions Permissions `json:"permissions,omitempty"`
}

EntityInfoProperties the generic properties of an entity.

type EntityListResult

type EntityListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of entities.
	Value *[]EntityInfo `json:"value,omitempty"`
	// NextLink - READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

EntityListResult describes the result of the request to view entities.

func (EntityListResult) IsEmpty

func (elr EntityListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (EntityListResult) MarshalJSON

func (elr EntityListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EntityListResult.

type EntityListResultIterator

type EntityListResultIterator struct {
	// contains filtered or unexported fields
}

EntityListResultIterator provides access to a complete listing of EntityInfo values.

func NewEntityListResultIterator

func NewEntityListResultIterator(page EntityListResultPage) EntityListResultIterator

Creates a new instance of the EntityListResultIterator type.

func (*EntityListResultIterator) Next

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 (*EntityListResultIterator) NextWithContext

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 (EntityListResultIterator) NotDone

func (iter EntityListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (EntityListResultIterator) Response

Response returns the raw server response from the last page request.

func (EntityListResultIterator) Value

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.

type EntityListResultPage

type EntityListResultPage struct {
	// contains filtered or unexported fields
}

EntityListResultPage contains a page of EntityInfo values.

func NewEntityListResultPage

func NewEntityListResultPage(cur EntityListResult, getNextPage func(context.Context, EntityListResult) (EntityListResult, error)) EntityListResultPage

Creates a new instance of the EntityListResultPage type.

func (*EntityListResultPage) Next

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 (*EntityListResultPage) NextWithContext

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 (EntityListResultPage) NotDone

func (page EntityListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (EntityListResultPage) Response

func (page EntityListResultPage) Response() EntityListResult

Response returns the raw server response from the last page request.

func (EntityListResultPage) Values

func (page EntityListResultPage) Values() []EntityInfo

Values returns the slice of values for the current page or nil if there are no values.

type EntityParentGroupInfo

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"`
}

EntityParentGroupInfo (Optional) The ID of the parent management group.

type ErrorDetails

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"`
}

ErrorDetails the details of the error.

type ErrorResponse

type ErrorResponse struct {
	Error *ErrorDetails `json:"error,omitempty"`
}

ErrorResponse the error object.

type Info

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, /providers/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"`
}

Info the management group resource.

func (Info) MarshalJSON

func (i Info) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Info.

func (*Info) UnmarshalJSON

func (i *Info) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Info struct.

type InfoProperties

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"`
}

InfoProperties the generic properties of a management group.

type ListResult

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"`
}

ListResult describes the result of the request to list management groups.

func (ListResult) IsEmpty

func (lr ListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (ListResult) MarshalJSON

func (lr ListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ListResult.

type ListResultIterator

type ListResultIterator struct {
	// contains filtered or unexported fields
}

ListResultIterator provides access to a complete listing of Info 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() Info

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 Info 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() []Info

Values returns the slice of values for the current page or nil if there are no values.

type ManagementGroup

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, /providers/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"`
}

ManagementGroup the management group details.

func (ManagementGroup) MarshalJSON

func (mg ManagementGroup) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ManagementGroup.

func (*ManagementGroup) UnmarshalJSON

func (mg *ManagementGroup) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ManagementGroup struct.

type Operation

type Operation struct {
	// Name - READ-ONLY; Operation name: {provider}/{resource}/{operation}.
	Name    *string                     `json:"name,omitempty"`
	Display *OperationDisplayProperties `json:"display,omitempty"`
}

Operation operation supported by the Microsoft.Management resource provider.

func (Operation) MarshalJSON

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Operation.

type OperationDisplayProperties

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"`
}

OperationDisplayProperties the object that represents the operation.

type OperationListResult

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"`
}

OperationListResult describes the result of the request to list Microsoft.Management operations.

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

Response returns the raw server response from the last page request.

func (OperationListResultIterator) Value

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

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 OperationResults

type OperationResults 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, /providers/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"`
	*OperationResultsProperties `json:"properties,omitempty"`
}

OperationResults the results of an asynchronous operation.

func (OperationResults) MarshalJSON

func (or OperationResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationResults.

func (*OperationResults) UnmarshalJSON

func (or *OperationResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for OperationResults struct.

type OperationResultsProperties

type OperationResultsProperties struct {
	// ProvisioningState - Possible values include: 'Updating'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}

OperationResultsProperties ...

type OperationsClient

type OperationsClient struct {
	BaseClient
}

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.

func NewOperationsClient

func NewOperationsClient(operationResultID string, skiptoken string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, operationResultID string, skiptoken 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 Management 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

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

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

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.

type ParentGroupInfo

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"`
}

ParentGroupInfo (Optional) The ID of the parent management group.

type PatchManagementGroupRequest

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"`
}

PatchManagementGroupRequest management group patch parameters.

type Permissions

type Permissions string

Permissions enumerates the values for permissions.

const (
	// Delete ...
	Delete Permissions = "delete"
	// Edit ...
	Edit Permissions = "edit"
	// Noaccess ...
	Noaccess Permissions = "noaccess"
	// View ...
	View Permissions = "view"
)

func PossiblePermissionsValues

func PossiblePermissionsValues() []Permissions

PossiblePermissionsValues returns an array of possible values for the Permissions const type.

type Permissions1

type Permissions1 string

Permissions1 enumerates the values for permissions 1.

const (
	// Permissions1Delete ...
	Permissions1Delete Permissions1 = "delete"
	// Permissions1Edit ...
	Permissions1Edit Permissions1 = "edit"
	// Permissions1Noaccess ...
	Permissions1Noaccess Permissions1 = "noaccess"
	// Permissions1View ...
	Permissions1View Permissions1 = "view"
)

func PossiblePermissions1Values

func PossiblePermissions1Values() []Permissions1

PossiblePermissions1Values returns an array of possible values for the Permissions1 const type.

type Properties

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"`
}

Properties the generic properties of a management group.

type ProvisioningState

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

const (
	// Updating ...
	Updating ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type Reason

type Reason string

Reason enumerates the values for reason.

const (
	// AlreadyExists ...
	AlreadyExists Reason = "AlreadyExists"
	// Invalid ...
	Invalid Reason = "Invalid"
)

func PossibleReasonValues

func PossibleReasonValues() []Reason

PossibleReasonValues returns an array of possible values for the Reason const type.

type SetObject

type SetObject struct {
	autorest.Response `json:"-"`
	Value             interface{} `json:"value,omitempty"`
}

SetObject ...

type SubscriptionsClient

type SubscriptionsClient struct {
	BaseClient
}

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.

func NewSubscriptionsClient

func NewSubscriptionsClient(operationResultID string, skiptoken string) SubscriptionsClient

NewSubscriptionsClient creates an instance of the SubscriptionsClient client.

func NewSubscriptionsClientWithBaseURI

func NewSubscriptionsClientWithBaseURI(baseURI string, operationResultID string, skiptoken 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 (SubscriptionsClient) Create

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 (SubscriptionsClient) CreatePreparer

func (client SubscriptionsClient) CreatePreparer(ctx context.Context, groupID string, subscriptionID string, cacheControl string) (*http.Request, error)

CreatePreparer prepares the Create request.

func (SubscriptionsClient) CreateResponder

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 (SubscriptionsClient) CreateSender

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 (SubscriptionsClient) Delete

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 (SubscriptionsClient) DeletePreparer

func (client SubscriptionsClient) DeletePreparer(ctx context.Context, groupID string, subscriptionID string, cacheControl string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (SubscriptionsClient) DeleteResponder

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 (SubscriptionsClient) DeleteSender

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.

type Type

type Type string

Type enumerates the values for type.

const (
	// ProvidersMicrosoftManagementmanagementGroups ...
	ProvidersMicrosoftManagementmanagementGroups Type = "/providers/Microsoft.Management/managementGroups"
)

func PossibleTypeValues

func PossibleTypeValues() []Type

PossibleTypeValues returns an array of possible values for the Type const type.

type Type1

type Type1 string

Type1 enumerates the values for type 1.

const (
	// Type1ProvidersMicrosoftManagementmanagementGroups ...
	Type1ProvidersMicrosoftManagementmanagementGroups Type1 = "/providers/Microsoft.Management/managementGroups"
	// Type1Subscriptions ...
	Type1Subscriptions Type1 = "/subscriptions"
)

func PossibleType1Values

func PossibleType1Values() []Type1

PossibleType1Values returns an array of possible values for the Type1 const type.

type Type2

type Type2 string

Type2 enumerates the values for type 2.

const (
	// Type2ProvidersMicrosoftManagementmanagementGroups ...
	Type2ProvidersMicrosoftManagementmanagementGroups Type2 = "/providers/Microsoft.Management/managementGroups"
	// Type2Subscriptions ...
	Type2Subscriptions Type2 = "/subscriptions"
)

func PossibleType2Values

func PossibleType2Values() []Type2

PossibleType2Values returns an array of possible values for the Type2 const type.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL