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

package managementgroups

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

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

Package Files

client.go entities.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
    OperationResultID string
    Skiptoken         string
}

BaseClient is the base client for Managementgroups.

func New Uses

func New(operationResultID string, skiptoken string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string, operationResultID string, skiptoken string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

func (BaseClient) CheckNameAvailability Uses

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 Uses

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

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (BaseClient) CheckNameAvailabilityResponder Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 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(operationResultID string, skiptoken string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI Uses

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

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

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 Uses

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 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) (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 Uses

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 Uses

func (client Client) ListPreparer(ctx context.Context, cacheControl 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, 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 Uses

func (client Client) UpdatePreparer(ctx context.Context, groupID string, patchGroupRequest PatchManagementGroupRequest, 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 CreateManagementGroupChildInfo Uses

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 Uses

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.

type CreateManagementGroupProperties Uses

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.

type CreateManagementGroupRequest Uses

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 Uses

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

MarshalJSON is the custom marshaler for CreateManagementGroupRequest.

func (*CreateManagementGroupRequest) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for CreateManagementGroupRequest struct.

type CreateOrUpdateFuture Uses

type CreateOrUpdateFuture struct {
    azure.Future
}

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

func (*CreateOrUpdateFuture) Result Uses

func (future *CreateOrUpdateFuture) Result(client Client) (so SetObject, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type CreateParentGroupInfo Uses

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.

type DeleteFuture Uses

type DeleteFuture struct {
    azure.Future
}

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

func (*DeleteFuture) Result Uses

func (future *DeleteFuture) Result(client Client) (or OperationResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

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

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 Uses

func NewEntitiesClient(operationResultID string, skiptoken string) EntitiesClient

NewEntitiesClient creates an instance of the EntitiesClient client.

func NewEntitiesClientWithBaseURI Uses

func NewEntitiesClientWithBaseURI(baseURI string, operationResultID string, skiptoken string) EntitiesClient

NewEntitiesClientWithBaseURI creates an instance of the EntitiesClient client.

func (EntitiesClient) List Uses

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 Uses

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 Uses

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

ListPreparer prepares the List request.

func (EntitiesClient) ListResponder Uses

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 Uses

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 Uses

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 Uses

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

MarshalJSON is the custom marshaler for EntityHierarchyItem.

func (*EntityHierarchyItem) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for EntityHierarchyItem struct.

type EntityHierarchyItemProperties Uses

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 Uses

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 Uses

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

MarshalJSON is the custom marshaler for EntityInfo.

func (*EntityInfo) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for EntityInfo struct.

type EntityInfoProperties Uses

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 Uses

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 Uses

func (elr EntityListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type EntityListResultIterator Uses

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

EntityListResultIterator provides access to a complete listing of EntityInfo values.

func NewEntityListResultIterator Uses

func NewEntityListResultIterator(page EntityListResultPage) EntityListResultIterator

Creates a new instance of the EntityListResultIterator type.

func (*EntityListResultIterator) Next Uses

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 Uses

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 Uses

func (iter EntityListResultIterator) NotDone() bool

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

func (EntityListResultIterator) Response Uses

func (iter EntityListResultIterator) Response() EntityListResult

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

func (EntityListResultIterator) Value Uses

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 Uses

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

EntityListResultPage contains a page of EntityInfo values.

func NewEntityListResultPage Uses

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

Creates a new instance of the EntityListResultPage type.

func (*EntityListResultPage) Next Uses

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 Uses

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 Uses

func (page EntityListResultPage) NotDone() bool

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

func (EntityListResultPage) Response Uses

func (page EntityListResultPage) Response() EntityListResult

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

func (EntityListResultPage) Values Uses

func (page EntityListResultPage) Values() []EntityInfo

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

type EntityParentGroupInfo Uses

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 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"`
    // Details - A human-readable representation of the error's details.
    Details *string `json:"details,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 *OperationDisplayProperties `json:"display,omitempty"`
}

Operation operation supported by the Microsoft.Management resource provider.

type OperationDisplayProperties Uses

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

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 Uses

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

MarshalJSON is the custom marshaler for OperationResults.

func (*OperationResults) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for OperationResults struct.

type OperationResultsProperties Uses

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

OperationResultsProperties ...

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(operationResultID string, skiptoken string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

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

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 Uses

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 Uses

func PossiblePermissionsValues() []Permissions

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

type Permissions1 Uses

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 Uses

func PossiblePermissions1Values() []Permissions1

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

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"`
    // 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 Uses

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

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

func PossibleProvisioningStateValues Uses

func PossibleProvisioningStateValues() []ProvisioningState

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

type Reason Uses

type Reason string

Reason enumerates the values for reason.

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

func PossibleReasonValues Uses

func PossibleReasonValues() []Reason

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

type SetObject Uses

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

SetObject ...

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(operationResultID string, skiptoken string) SubscriptionsClient

NewSubscriptionsClient creates an instance of the SubscriptionsClient client.

func NewSubscriptionsClientWithBaseURI Uses

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

type Type Uses

type Type string

Type enumerates the values for type.

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

func PossibleTypeValues Uses

func PossibleTypeValues() []Type

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

type Type1 Uses

type Type1 string

Type1 enumerates the values for type 1.

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

func PossibleType1Values Uses

func PossibleType1Values() []Type1

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

type Type2 Uses

type Type2 string

Type2 enumerates the values for type 2.

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

func PossibleType2Values Uses

func PossibleType2Values() []Type2

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

Directories

PathSynopsis
managementgroupsapi

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