azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/preview/resources/mgmt/2017-11-01-preview/managementgroups Index | Files | Directories

package managementgroups

import "github.com/Azure/azure-sdk-for-go/services/preview/resources/mgmt/2017-11-01-preview/managementgroups"

Package managementgroups implements the Azure ARM Managementgroups service API version 2017-11-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

Package Files

client.go managementgroups.go models.go operations.go subscriptions.go version.go

Constants

const (
    // DefaultBaseURI is the default URI used for the service Managementgroups
    DefaultBaseURI = "https://management.azure.com"
)

func UserAgent Uses

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version Uses

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

type BaseClient Uses

type BaseClient struct {
    autorest.Client
    BaseURI string
}

BaseClient is the base client for Managementgroups.

func New Uses

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type ChildInfo Uses

type ChildInfo struct {
    // ChildType - Possible values include: 'ChildTypeManagementGroup', 'ChildTypeSubscription'
    ChildType ChildType `json:"childType,omitempty"`
    // ChildID - The fully qualified ID for the child resource (management group or subscription).  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
    ChildID *string `json:"childId,omitempty"`
    // DisplayName - The friendly name of the child resource.
    DisplayName *string `json:"displayName,omitempty"`
    // Children - The list of children.
    Children *[]ChildInfo `json:"children,omitempty"`
}

ChildInfo the child information of a management group.

type ChildType Uses

type ChildType string

ChildType enumerates the values for child type.

const (
    // ChildTypeManagementGroup ...
    ChildTypeManagementGroup ChildType = "ManagementGroup"
    // ChildTypeSubscription ...
    ChildTypeSubscription ChildType = "Subscription"
)

func PossibleChildTypeValues Uses

func PossibleChildTypeValues() []ChildType

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

type Client Uses

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 Uses

func NewClient() Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI Uses

func NewClientWithBaseURI(baseURI string) Client

NewClientWithBaseURI creates an instance of the Client client.

func (Client) CreateOrUpdate Uses

func (client Client) CreateOrUpdate(ctx context.Context, groupID string, createManagementGroupRequest CreateManagementGroupRequest, cacheControl string) (result ManagementGroup, 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 Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (Client) CreateOrUpdateResponder Uses

func (client Client) CreateOrUpdateResponder(resp *http.Response) (result ManagementGroup, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (Client) CreateOrUpdateSender Uses

func (client Client) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (Client) Delete Uses

func (client Client) Delete(ctx context.Context, groupID string, cacheControl string) (result autorest.Response, 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 Uses

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

DeletePreparer prepares the Delete request.

func (Client) DeleteResponder Uses

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

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

func (Client) DeleteSender Uses

func (client Client) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (Client) Get Uses

func (client Client) Get(ctx context.Context, groupID string, expand string, recurse *bool, 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. cacheControl - indicates that the request shouldn't utilize any caches.

func (Client) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (Client) GetResponder Uses

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 Uses

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 Uses

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

List list management groups for the authenticated user. Parameters: cacheControl - indicates that the request shouldn't utilize any caches. skiptoken - page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

func (Client) ListComplete Uses

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

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

func (Client) ListPreparer Uses

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

ListPreparer prepares the List request.

func (Client) ListResponder Uses

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 Uses

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 Uses

func (client Client) Update(ctx context.Context, groupID string, createManagementGroupRequest CreateManagementGroupRequest, cacheControl string) (result ManagementGroup, err error)

Update update a management group. Parameters: groupID - management Group ID. createManagementGroupRequest - management group creation parameters. cacheControl - indicates that the request shouldn't utilize any caches.

func (Client) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (Client) UpdateResponder Uses

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 Uses

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 CreateManagementGroupRequest Uses

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

CreateManagementGroupRequest management group creation parameters.

type Details Uses

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 ErrorDetails Uses

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

ErrorDetails the details of the error.

type ErrorResponse Uses

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

ErrorResponse the error object.

type Info Uses

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 Uses

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

MarshalJSON is the custom marshaler for Info.

func (*Info) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for Info struct.

type InfoProperties Uses

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 Uses

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 Uses

func (lr ListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListResultIterator Uses

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

ListResultIterator provides access to a complete listing of Info values.

func NewListResultIterator Uses

func NewListResultIterator(page ListResultPage) ListResultIterator

Creates a new instance of the ListResultIterator type.

func (*ListResultIterator) Next Uses

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 Uses

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 Uses

func (iter ListResultIterator) NotDone() bool

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

func (ListResultIterator) Response Uses

func (iter ListResultIterator) Response() ListResult

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

func (ListResultIterator) Value Uses

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 Uses

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

ListResultPage contains a page of Info values.

func NewListResultPage Uses

func NewListResultPage(getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage

Creates a new instance of the ListResultPage type.

func (*ListResultPage) Next Uses

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 Uses

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 Uses

func (page ListResultPage) NotDone() bool

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

func (ListResultPage) Response Uses

func (page ListResultPage) Response() ListResult

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

func (ListResultPage) Values Uses

func (page ListResultPage) Values() []Info

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

type ManagementGroup Uses

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 Uses

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

MarshalJSON is the custom marshaler for ManagementGroup.

func (*ManagementGroup) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for ManagementGroup struct.

type Operation Uses

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 operation supported by the Microsoft.Management resource provider.

type OperationDisplay Uses

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

OperationDisplay the object that represents the operation.

type OperationListResult Uses

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 Uses

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator Uses

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator Uses

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next Uses

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 Uses

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 Uses

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response Uses

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value Uses

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 Uses

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage Uses

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

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next Uses

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 Uses

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 Uses

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response Uses

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values Uses

func (page OperationListResultPage) Values() []Operation

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

type OperationsClient Uses

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 Uses

func NewOperationsClient() OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

func NewOperationsClientWithBaseURI(baseURI string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List Uses

func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List lists all of the available Management REST API operations.

func (OperationsClient) ListComplete Uses

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

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

func (OperationsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

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 Uses

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 Uses

type ParentGroupInfo struct {
    // ParentID - 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"`
    // DisplayName - The friendly name of the parent management group.
    DisplayName *string `json:"displayName,omitempty"`
}

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

type Properties Uses

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"`
    Details     *Details `json:"details,omitempty"`
    // Children - The list of children.
    Children *[]ChildInfo `json:"children,omitempty"`
}

Properties the generic properties of a management group.

type SubscriptionsClient Uses

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 Uses

func NewSubscriptionsClient() SubscriptionsClient

NewSubscriptionsClient creates an instance of the SubscriptionsClient client.

func NewSubscriptionsClientWithBaseURI Uses

func NewSubscriptionsClientWithBaseURI(baseURI string) SubscriptionsClient

NewSubscriptionsClientWithBaseURI creates an instance of the SubscriptionsClient client.

func (SubscriptionsClient) Create Uses

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 Uses

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

CreatePreparer prepares the Create request.

func (SubscriptionsClient) CreateResponder Uses

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 Uses

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 Uses

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 Uses

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

DeletePreparer prepares the Delete request.

func (SubscriptionsClient) DeleteResponder Uses

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 Uses

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.

Directories

PathSynopsis
managementgroupsapi

Package managementgroups imports 9 packages (graph) and is imported by 4 packages. Updated 2019-08-08. Refresh now. Tools for package owners.