management

package
v11.3.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Dec 12, 2017 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package management implements the Azure ARM Management 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 Management
	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 ChildType 

type ChildType string

ChildType enumerates the values for child type. 

const (
	// Account specifies the account state for child type.
	Account ChildType = "Account"
	// Department specifies the department state for child type.
	Department ChildType = "Department"
	// Enrollment specifies the enrollment state for child type.
	Enrollment ChildType = "Enrollment"
	// Subscription specifies the subscription state for child type.
	Subscription ChildType = "Subscription"
)

type ChildType1 

type ChildType1 string

ChildType1 enumerates the values for child type 1. 

const (
	// ChildType1Account specifies the child type 1 account state for child type 1.
	ChildType1Account ChildType1 = "Account"
	// ChildType1Department specifies the child type 1 department state for child type 1.
	ChildType1Department ChildType1 = "Department"
	// ChildType1Enrollment specifies the child type 1 enrollment state for child type 1.
	ChildType1Enrollment ChildType1 = "Enrollment"
	// ChildType1Subscription specifies the child type 1 subscription state for child type 1.
	ChildType1Subscription ChildType1 = "Subscription"
)

type ErrorDetails 

type ErrorDetails struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
	Target  *string `json:"target,omitempty"`
}

ErrorDetails is the details of the error.

type ErrorResponse 

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

ErrorResponse is the error object.

type Group 

type Group struct {
	ID               *string    `json:"id,omitempty"`
	Type             *string    `json:"type,omitempty"`
	Name             *uuid.UUID `json:"name,omitempty"`
	*GroupProperties `json:"properties,omitempty"`
}

Group is the management group details.

type GroupChildInfo 

type GroupChildInfo struct {
	ChildType   ChildType  `json:"childType,omitempty"`
	ChildID     *string    `json:"childId,omitempty"`
	DisplayName *string    `json:"displayName,omitempty"`
	TenantID    *uuid.UUID `json:"tenantId,omitempty"`
}

GroupChildInfo is the unique identifier (ID) of a management group.

type GroupDetailsProperties 

type GroupDetailsProperties struct {
	Version             *float64            `json:"version,omitempty"`
	UpdatedTime         *date.Time          `json:"updatedTime,omitempty"`
	UpdatedBy           *string             `json:"updatedBy,omitempty"`
	Parent              *ParentGroupInfo    `json:"parent,omitempty"`
	ManagementGroupType ManagementGroupType `json:"managementGroupType,omitempty"`
}

GroupDetailsProperties is the details properties of a management group.

type GroupInfo 

type GroupInfo struct {
	ID                   *string    `json:"id,omitempty"`
	Type                 *string    `json:"type,omitempty"`
	Name                 *uuid.UUID `json:"name,omitempty"`
	*GroupInfoProperties `json:"properties,omitempty"`
}

GroupInfo is the management group.

type GroupInfoProperties 

type GroupInfoProperties struct {
	TenantID    *uuid.UUID `json:"tenantId,omitempty"`
	DisplayName *string    `json:"displayName,omitempty"`
}

GroupInfoProperties is the generic properties of a management group.

type GroupListResult 

type GroupListResult struct {
	autorest.Response `json:"-"`
	Value             *[]GroupInfo `json:"value,omitempty"`
	NextLink          *string      `json:"nextLink,omitempty"`
}

GroupListResult is the result of listing management groups.

func (GroupListResult) GroupListResultPreparer 

func (client GroupListResult) GroupListResultPreparer() (*http.Request, error)

GroupListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type GroupProperties 

type GroupProperties struct {
	TenantID    *uuid.UUID              `json:"tenantId,omitempty"`
	DisplayName *string                 `json:"displayName,omitempty"`
	Details     *GroupDetailsProperties `json:"details,omitempty"`
}

GroupProperties is the generic properties of a management group.

type GroupPropertiesWithChildren 

type GroupPropertiesWithChildren struct {
	TenantID    *uuid.UUID              `json:"tenantId,omitempty"`
	DisplayName *string                 `json:"displayName,omitempty"`
	Details     *GroupDetailsProperties `json:"details,omitempty"`
	Children    *[]GroupChildInfo       `json:"children,omitempty"`
}

GroupPropertiesWithChildren is the generic properties of a management group.

type GroupPropertiesWithHierarchy 

type GroupPropertiesWithHierarchy struct {
	TenantID    *uuid.UUID                 `json:"tenantId,omitempty"`
	DisplayName *string                    `json:"displayName,omitempty"`
	Details     *GroupDetailsProperties    `json:"details,omitempty"`
	Children    *[]GroupRecursiveChildInfo `json:"children,omitempty"`
}

GroupPropertiesWithHierarchy is the generic properties of a management group.

type GroupRecursiveChildInfo 

type GroupRecursiveChildInfo struct {
	ChildType   ChildType                  `json:"childType,omitempty"`
	ChildID     *string                    `json:"childId,omitempty"`
	DisplayName *string                    `json:"displayName,omitempty"`
	TenantID    *uuid.UUID                 `json:"tenantId,omitempty"`
	Children    *[]GroupRecursiveChildInfo `json:"children,omitempty"`
}

GroupRecursiveChildInfo is the unique identifier (ID) of a management group.

type GroupWithChildren 

type GroupWithChildren struct {
	ID                           *string    `json:"id,omitempty"`
	Type                         *string    `json:"type,omitempty"`
	Name                         *uuid.UUID `json:"name,omitempty"`
	*GroupPropertiesWithChildren `json:"properties,omitempty"`
}

GroupWithChildren is the management group details.

type GroupWithHierarchy 

type GroupWithHierarchy struct {
	autorest.Response             `json:"-"`
	ID                            *string    `json:"id,omitempty"`
	Type                          *string    `json:"type,omitempty"`
	Name                          *uuid.UUID `json:"name,omitempty"`
	*GroupPropertiesWithHierarchy `json:"properties,omitempty"`
}

GroupWithHierarchy is the management group details.

type GroupsClient 

type GroupsClient struct {
	ManagementClient
}

GroupsClient 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 NewGroupsClient 

func NewGroupsClient(groupID uuid.UUID) GroupsClient

NewGroupsClient creates an instance of the GroupsClient client.

func NewGroupsClientWithBaseURI 

func NewGroupsClientWithBaseURI(baseURI string, groupID uuid.UUID) GroupsClient

NewGroupsClientWithBaseURI creates an instance of the GroupsClient client.

func (GroupsClient) Get 

func (client GroupsClient) Get(expand string, recurse *bool) (result GroupWithHierarchy, err error)

Get get the details of the management group.

expand is the $expand=children query string parameter allows clients to request inclusion of children in the response payload. recurse is the $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload.

func (GroupsClient) GetPreparer 

func (client GroupsClient) GetPreparer(expand string, recurse *bool) (*http.Request, error)

GetPreparer prepares the Get request.

func (GroupsClient) GetResponder 

func (client GroupsClient) GetResponder(resp *http.Response) (result GroupWithHierarchy, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (GroupsClient) GetSender 

func (client GroupsClient) 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 (GroupsClient) List 

func (client GroupsClient) List(skiptoken string) (result GroupListResult, err error)

List list management groups for the authenticated user.

skiptoken is 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 (GroupsClient) ListComplete 

func (client GroupsClient) ListComplete(skiptoken string, cancel <-chan struct{}) (<-chan GroupInfo, <-chan error)

ListComplete gets all elements from the list without paging.

func (GroupsClient) ListNextResults 

func (client GroupsClient) ListNextResults(lastResults GroupListResult) (result GroupListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (GroupsClient) ListPreparer 

func (client GroupsClient) ListPreparer(skiptoken string) (*http.Request, error)

ListPreparer prepares the List request.

func (GroupsClient) ListResponder 

func (client GroupsClient) ListResponder(resp *http.Response) (result GroupListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (GroupsClient) ListSender 

func (client GroupsClient) 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 ManagementClient 

type ManagementClient struct {
	autorest.Client
	BaseURI string
	GroupID uuid.UUID
}

ManagementClient is the base client for Management.

func New 

func New(groupID uuid.UUID) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, groupID uuid.UUID) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type ManagementGroupType 

type ManagementGroupType string

ManagementGroupType enumerates the values for management group type. 

const (
	// ManagementGroupTypeAccount specifies the management group type account state for management group type.
	ManagementGroupTypeAccount ManagementGroupType = "Account"
	// ManagementGroupTypeDepartment specifies the management group type department state for management group type.
	ManagementGroupTypeDepartment ManagementGroupType = "Department"
	// ManagementGroupTypeEnrollment specifies the management group type enrollment state for management group type.
	ManagementGroupTypeEnrollment ManagementGroupType = "Enrollment"
	// ManagementGroupTypeSubscription specifies the management group type subscription state for management group type.
	ManagementGroupTypeSubscription ManagementGroupType = "Subscription"
)

type Operation 

type Operation struct {
	Name    *string           `json:"name,omitempty"`
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation is a Management REST API operation.

type OperationDisplay 

type OperationDisplay struct {
	Provider  *string `json:"provider,omitempty"`
	Resource  *string `json:"resource,omitempty"`
	Operation *string `json:"operation,omitempty"`
}

OperationDisplay is the object that represents the operation.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	Value             *[]Operation `json:"value,omitempty"`
	NextLink          *string      `json:"nextLink,omitempty"`
}

OperationListResult is result listing operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) OperationListResultPreparer 

func (client OperationListResult) OperationListResultPreparer() (*http.Request, error)

OperationListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type OperationsClient 

type OperationsClient struct {
	ManagementClient
}

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.

func (OperationsClient) List 

func (client OperationsClient) List() (result OperationListResult, err error)

List lists all of the available management REST API operations.

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(cancel <-chan struct{}) (<-chan Operation, <-chan error)

ListComplete gets all elements from the list without paging.

func (OperationsClient) ListNextResults 

func (client OperationsClient) ListNextResults(lastResults OperationListResult) (result OperationListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer() (*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    *string `json:"parentId,omitempty"`
	DisplayName *string `json:"displayName,omitempty"`
}

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

Source Files

View all Source files

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.