managementgroups

package
v1.0.1 Latest Latest
Warning

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

 Go to latest Published: Aug 22, 2022 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package managementgroups implements the Azure ARM Managementgroups service API version 2017-08-31-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
	GroupID uuid.UUID
}

BaseClient is the base client for Managementgroups.

func New 

func New(groupID uuid.UUID) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, groupID uuid.UUID) 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).

type ChildInfo 

type ChildInfo struct {
	// ChildType - Possible values include: 'Enrollment', 'Department', 'Account', 'Subscription'
	ChildType ChildType `json:"childType,omitempty"`
	// ChildID - The ID of the child resource (management group or subscription). E.g. /providers/Microsoft.Management/managementGroups/40000000-0000-0000-0000-000000000000
	ChildID *string `json:"childId,omitempty"`
	// DisplayName - The friendly name of the child resource.
	DisplayName *string `json:"displayName,omitempty"`
	// TenantID - (Optional) The AAD Tenant ID associated with the child resource.
	TenantID *uuid.UUID `json:"tenantId,omitempty"`
}

ChildInfo the unique identifier (ID) of a management group.

type ChildType 

type ChildType string

ChildType enumerates the values for child type. 

const (
	// Account ...
	Account ChildType = "Account"
	// Department ...
	Department ChildType = "Department"
	// Enrollment ...
	Enrollment ChildType = "Enrollment"
	// Subscription ...
	Subscription ChildType = "Subscription"
)

func PossibleChildTypeValues 

func PossibleChildTypeValues() []ChildType

PossibleChildTypeValues returns an array of possible values for the ChildType const type.

type ChildType1 

type ChildType1 string

ChildType1 enumerates the values for child type 1. 

const (
	// ChildType1Account ...
	ChildType1Account ChildType1 = "Account"
	// ChildType1Department ...
	ChildType1Department ChildType1 = "Department"
	// ChildType1Enrollment ...
	ChildType1Enrollment ChildType1 = "Enrollment"
	// ChildType1Subscription ...
	ChildType1Subscription ChildType1 = "Subscription"
)

func PossibleChildType1Values 

func PossibleChildType1Values() []ChildType1

PossibleChildType1Values returns an array of possible values for the ChildType1 const type.

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(groupID uuid.UUID) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI 

func NewClientWithBaseURI(baseURI string, groupID uuid.UUID) 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) Get 

func (client Client) Get(ctx context.Context, expand string, recurse *bool) (result WithHierarchy, err error)

Get get the details of the management group. Parameters: 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.

func (Client) GetPreparer 

func (client Client) GetPreparer(ctx context.Context, expand string, recurse *bool) (*http.Request, error)

GetPreparer prepares the Get request.

func (Client) GetResponder 

func (client Client) GetResponder(resp *http.Response) (result WithHierarchy, 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, skiptoken string) (result ListResultPage, err error)

List list management groups 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.

func (Client) ListComplete 

func (client Client) ListComplete(ctx context.Context, skiptoken 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, skiptoken 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.

type DetailsProperties 

type DetailsProperties 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"`
	// ManagementGroupType - Possible values include: 'ManagementGroupTypeEnrollment', 'ManagementGroupTypeDepartment', 'ManagementGroupTypeAccount', 'ManagementGroupTypeSubscription'
	ManagementGroupType ManagementGroupType `json:"managementGroupType,omitempty"`
}

DetailsProperties the details properties of a 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"`
	// Target - (Optional) The target of the error.
	Target *string `json:"target,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 ID of the management group. E.g. /providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000
	ID *string `json:"id,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. /providers/Microsoft.Management/managementGroups
	Type *string `json:"type,omitempty"`
	// Name - READ-ONLY; The name of the management group. E.g. 20000000-0000-0000-0000-000000000000
	Name            *uuid.UUID `json:"name,omitempty"`
	*InfoProperties `json:"properties,omitempty"`
}

Info the management group.

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. E.g. 10000000-0000-0000-0000-000000000000
	TenantID *uuid.UUID `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 the next page of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ListResult the result of listing 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 {
	// ID - READ-ONLY; The ID of the management group. E.g. /providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000
	ID *string `json:"id,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. /providers/Microsoft.Management/managementGroups
	Type *string `json:"type,omitempty"`
	// Name - READ-ONLY; The name of the management group. E.g. 20000000-0000-0000-0000-000000000000
	Name        *uuid.UUID `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 ManagementGroupType 

type ManagementGroupType string

ManagementGroupType enumerates the values for management group type. 

const (
	// ManagementGroupTypeAccount ...
	ManagementGroupTypeAccount ManagementGroupType = "Account"
	// ManagementGroupTypeDepartment ...
	ManagementGroupTypeDepartment ManagementGroupType = "Department"
	// ManagementGroupTypeEnrollment ...
	ManagementGroupTypeEnrollment ManagementGroupType = "Enrollment"
	// ManagementGroupTypeSubscription ...
	ManagementGroupTypeSubscription ManagementGroupType = "Subscription"
)

func PossibleManagementGroupTypeValues 

func PossibleManagementGroupTypeValues() []ManagementGroupType

PossibleManagementGroupTypeValues returns an array of possible values for the ManagementGroupType const type.

type Operation 

type Operation struct {
	// Name - READ-ONLY; Operation name: {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`
	// Display - The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation a Management REST API operation.

func (Operation) MarshalJSON 

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

MarshalJSON is the custom marshaler for Operation.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - READ-ONLY; Service provider: Microsoft.Management.
	Provider *string `json:"provider,omitempty"`
	// Resource - READ-ONLY; Resource on which the operation is performed: Invoice, etc.
	Resource *string `json:"resource,omitempty"`
	// Operation - READ-ONLY; Operation type: Read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`
}

OperationDisplay the object that represents the operation.

func (OperationDisplay) MarshalJSON 

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

MarshalJSON is the custom marshaler for OperationDisplay.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of management 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 result listing operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OperationListResult) MarshalJSON 

func (olr OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationListResult.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator 

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next 

func (iter *OperationListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultIterator) NextWithContext 

func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListResultIterator) NotDone 

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListResultPage 

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage 

func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next 

func (page *OperationListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultPage) NextWithContext 

func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListResultPage) NotDone 

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

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

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the 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(groupID uuid.UUID) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, groupID uuid.UUID) 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 {
	// ParentID - The ID of the parent management group. E.g. /providers/Microsoft.Management/managementGroups/30000000-0000-0000-0000-000000000000
	ParentID *string `json:"parentId,omitempty"`
	// DisplayName - The friendly name of the management group.
	DisplayName *string `json:"displayName,omitempty"`
}

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

type Properties 

type Properties struct {
	// TenantID - The AAD Tenant ID associated with the management group. E.g. 10000000-0000-0000-0000-000000000000
	TenantID *uuid.UUID `json:"tenantId,omitempty"`
	// DisplayName - The friendly name of the management group.
	DisplayName *string            `json:"displayName,omitempty"`
	Details     *DetailsProperties `json:"details,omitempty"`
}

Properties the generic properties of a management group.

type PropertiesWithChildren 

type PropertiesWithChildren struct {
	// TenantID - The AAD Tenant ID associated with the management group. E.g. 10000000-0000-0000-0000-000000000000
	TenantID *uuid.UUID `json:"tenantId,omitempty"`
	// DisplayName - The friendly name of the management group.
	DisplayName *string            `json:"displayName,omitempty"`
	Details     *DetailsProperties `json:"details,omitempty"`
	// Children - The list of children.
	Children *[]ChildInfo `json:"children,omitempty"`
}

PropertiesWithChildren the generic properties of a management group.

type PropertiesWithHierarchy 

type PropertiesWithHierarchy struct {
	// TenantID - The AAD Tenant ID associated with the management group. E.g. 10000000-0000-0000-0000-000000000000
	TenantID *uuid.UUID `json:"tenantId,omitempty"`
	// DisplayName - The friendly name of the management group.
	DisplayName *string            `json:"displayName,omitempty"`
	Details     *DetailsProperties `json:"details,omitempty"`
	// Children - The list of children.
	Children *[]RecursiveChildInfo `json:"children,omitempty"`
}

PropertiesWithHierarchy the generic properties of a management group.

type RecursiveChildInfo 

type RecursiveChildInfo struct {
	// ChildType - Possible values include: 'ChildType1Enrollment', 'ChildType1Department', 'ChildType1Account', 'ChildType1Subscription'
	ChildType ChildType1 `json:"childType,omitempty"`
	// ChildID - The ID of the child resource (management group or subscription). E.g. /providers/Microsoft.Management/managementGroups/40000000-0000-0000-0000-000000000000
	ChildID *string `json:"childId,omitempty"`
	// DisplayName - The friendly name of the child resource.
	DisplayName *string `json:"displayName,omitempty"`
	// TenantID - (Optional) The AAD Tenant ID associated with the child resource.
	TenantID *uuid.UUID `json:"tenantId,omitempty"`
	// Children - The list of children.
	Children *[]RecursiveChildInfo `json:"children,omitempty"`
}

RecursiveChildInfo the unique identifier (ID) of a management group.

type WithChildren 

type WithChildren struct {
	// ID - READ-ONLY; The ID of the management group. E.g. /providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000
	ID *string `json:"id,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. /providers/Microsoft.Management/managementGroups
	Type *string `json:"type,omitempty"`
	// Name - READ-ONLY; The name of the management group. E.g. 20000000-0000-0000-0000-000000000000
	Name                    *uuid.UUID `json:"name,omitempty"`
	*PropertiesWithChildren `json:"properties,omitempty"`
}

WithChildren the management group details.

func (WithChildren) MarshalJSON 

func (wc WithChildren) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WithChildren.

func (*WithChildren) UnmarshalJSON 

func (wc *WithChildren) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for WithChildren struct.

type WithHierarchy 

type WithHierarchy struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The ID of the management group. E.g. /providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000
	ID *string `json:"id,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. /providers/Microsoft.Management/managementGroups
	Type *string `json:"type,omitempty"`
	// Name - READ-ONLY; The name of the management group. E.g. 20000000-0000-0000-0000-000000000000
	Name                     *uuid.UUID `json:"name,omitempty"`
	*PropertiesWithHierarchy `json:"properties,omitempty"`
}

WithHierarchy the management group details.

func (WithHierarchy) MarshalJSON 

func (wh WithHierarchy) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WithHierarchy.

func (*WithHierarchy) UnmarshalJSON 

func (wh *WithHierarchy) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for WithHierarchy struct.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.