Documentation ¶
Overview ¶
Package management implements the Azure ARM Management 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 ¶
- Constants
- func UserAgent() string
- func Version() string
- type BaseClient
- type ChildType
- type CreateManagementGroupRequest
- type ErrorDetails
- type ErrorResponse
- type Group
- type GroupChildInfo
- type GroupDetails
- type GroupInfo
- type GroupInfoProperties
- type GroupListResult
- type GroupListResultIterator
- type GroupListResultPage
- type GroupProperties
- type GroupSubscriptionsClient
- func (client GroupSubscriptionsClient) Create(ctx context.Context, groupID string, subscriptionID string, ...) (result autorest.Response, err error)
- func (client GroupSubscriptionsClient) CreatePreparer(ctx context.Context, groupID string, subscriptionID string, ...) (*http.Request, error)
- func (client GroupSubscriptionsClient) CreateResponder(resp *http.Response) (result autorest.Response, err error)
- func (client GroupSubscriptionsClient) CreateSender(req *http.Request) (*http.Response, error)
- func (client GroupSubscriptionsClient) Delete(ctx context.Context, groupID string, subscriptionID string, ...) (result autorest.Response, err error)
- func (client GroupSubscriptionsClient) DeletePreparer(ctx context.Context, groupID string, subscriptionID string, ...) (*http.Request, error)
- func (client GroupSubscriptionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client GroupSubscriptionsClient) DeleteSender(req *http.Request) (*http.Response, error)
- type GroupsClient
- func (client GroupsClient) CreateOrUpdate(ctx context.Context, groupID string, ...) (result Group, err error)
- func (client GroupsClient) CreateOrUpdatePreparer(ctx context.Context, groupID string, ...) (*http.Request, error)
- func (client GroupsClient) CreateOrUpdateResponder(resp *http.Response) (result Group, err error)
- func (client GroupsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client GroupsClient) Delete(ctx context.Context, groupID string, cacheControl string) (result autorest.Response, err error)
- func (client GroupsClient) DeletePreparer(ctx context.Context, groupID string, cacheControl string) (*http.Request, error)
- func (client GroupsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client GroupsClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client GroupsClient) Get(ctx context.Context, groupID string, expand string, recurse *bool, ...) (result Group, err error)
- func (client GroupsClient) GetPreparer(ctx context.Context, groupID string, expand string, recurse *bool, ...) (*http.Request, error)
- func (client GroupsClient) GetResponder(resp *http.Response) (result Group, err error)
- func (client GroupsClient) GetSender(req *http.Request) (*http.Response, error)
- func (client GroupsClient) List(ctx context.Context, cacheControl string, skiptoken string) (result GroupListResultPage, err error)
- func (client GroupsClient) ListComplete(ctx context.Context, cacheControl string, skiptoken string) (result GroupListResultIterator, err error)
- func (client GroupsClient) ListPreparer(ctx context.Context, cacheControl string, skiptoken string) (*http.Request, error)
- func (client GroupsClient) ListResponder(resp *http.Response) (result GroupListResult, err error)
- func (client GroupsClient) ListSender(req *http.Request) (*http.Response, error)
- func (client GroupsClient) Update(ctx context.Context, groupID string, ...) (result Group, err error)
- func (client GroupsClient) UpdatePreparer(ctx context.Context, groupID string, ...) (*http.Request, error)
- func (client GroupsClient) UpdateResponder(resp *http.Response) (result Group, err error)
- func (client GroupsClient) UpdateSender(req *http.Request) (*http.Response, error)
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationListResultIterator
- type OperationListResultPage
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type ParentGroupInfo
Constants ¶
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 BaseClient ¶
BaseClient is the base client for Management.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client.
type CreateManagementGroupRequest ¶
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 ErrorDetails ¶
type ErrorDetails struct { // Code - One of a server-defined set of error codes. Code *string `json:"code,omitempty"` // Message - A human-readable representation of the error. Message *string `json:"message,omitempty"` }
ErrorDetails the details of the error.
type ErrorResponse ¶
type ErrorResponse struct {
Error *ErrorDetails `json:"error,omitempty"`
}
ErrorResponse the error object.
type Group ¶
type Group struct { autorest.Response `json:"-"` // ID - 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 - 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"` *GroupProperties `json:"properties,omitempty"` }
Group the management group details.
func (*Group) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for Group struct.
type GroupChildInfo ¶
type GroupChildInfo struct { // ChildType - Possible values include: 'ManagementGroup', 'Subscription' 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 *[]GroupChildInfo `json:"children,omitempty"` }
GroupChildInfo the child information of a management group.
type GroupDetails ¶
type GroupDetails 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"` }
GroupDetails the details of a management group.
type GroupInfo ¶
type GroupInfo struct { // ID - 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 - 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"` *GroupInfoProperties `json:"properties,omitempty"` }
GroupInfo the management group resource.
func (*GroupInfo) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for GroupInfo struct.
type GroupInfoProperties ¶
type GroupInfoProperties 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"` }
GroupInfoProperties the generic properties of a management group.
type GroupListResult ¶
type GroupListResult struct { autorest.Response `json:"-"` // Value - The list of management groups. Value *[]GroupInfo `json:"value,omitempty"` // NextLink - The URL to use for getting the next set of results. NextLink *string `json:"nextLink,omitempty"` }
GroupListResult describes the result of the request to list management groups.
func (GroupListResult) IsEmpty ¶
func (glr GroupListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type GroupListResultIterator ¶
type GroupListResultIterator struct {
// contains filtered or unexported fields
}
GroupListResultIterator provides access to a complete listing of GroupInfo values.
func (*GroupListResultIterator) Next ¶
func (iter *GroupListResultIterator) 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.
func (GroupListResultIterator) NotDone ¶
func (iter GroupListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (GroupListResultIterator) Response ¶
func (iter GroupListResultIterator) Response() GroupListResult
Response returns the raw server response from the last page request.
func (GroupListResultIterator) Value ¶
func (iter GroupListResultIterator) Value() GroupInfo
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type GroupListResultPage ¶
type GroupListResultPage struct {
// contains filtered or unexported fields
}
GroupListResultPage contains a page of GroupInfo values.
func (*GroupListResultPage) Next ¶
func (page *GroupListResultPage) 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.
func (GroupListResultPage) NotDone ¶
func (page GroupListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (GroupListResultPage) Response ¶
func (page GroupListResultPage) Response() GroupListResult
Response returns the raw server response from the last page request.
func (GroupListResultPage) Values ¶
func (page GroupListResultPage) Values() []GroupInfo
Values returns the slice of values for the current page or nil if there are no values.
type GroupProperties ¶
type GroupProperties 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 *GroupDetails `json:"details,omitempty"` // Children - The list of children. Children *[]GroupChildInfo `json:"children,omitempty"` }
GroupProperties the generic properties of a management group.
type GroupSubscriptionsClient ¶
type GroupSubscriptionsClient struct {
BaseClient
}
GroupSubscriptionsClient 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 NewGroupSubscriptionsClient ¶
func NewGroupSubscriptionsClient() GroupSubscriptionsClient
NewGroupSubscriptionsClient creates an instance of the GroupSubscriptionsClient client.
func NewGroupSubscriptionsClientWithBaseURI ¶
func NewGroupSubscriptionsClientWithBaseURI(baseURI string) GroupSubscriptionsClient
NewGroupSubscriptionsClientWithBaseURI creates an instance of the GroupSubscriptionsClient client.
func (GroupSubscriptionsClient) Create ¶
func (client GroupSubscriptionsClient) Create(ctx context.Context, groupID string, subscriptionID string, cacheControl string) (result autorest.Response, err error)
Create associates existing subscription with the management group.
groupID is management Group ID. subscriptionID is subscription ID. cacheControl is indicates that the request shouldn't utilize any caches.
func (GroupSubscriptionsClient) CreatePreparer ¶
func (client GroupSubscriptionsClient) CreatePreparer(ctx context.Context, groupID string, subscriptionID string, cacheControl string) (*http.Request, error)
CreatePreparer prepares the Create request.
func (GroupSubscriptionsClient) CreateResponder ¶
func (client GroupSubscriptionsClient) 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 (GroupSubscriptionsClient) CreateSender ¶
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (GroupSubscriptionsClient) Delete ¶
func (client GroupSubscriptionsClient) Delete(ctx context.Context, groupID string, subscriptionID string, cacheControl string) (result autorest.Response, err error)
Delete de-associates subscription from the management group.
groupID is management Group ID. subscriptionID is subscription ID. cacheControl is indicates that the request shouldn't utilize any caches.
func (GroupSubscriptionsClient) DeletePreparer ¶
func (client GroupSubscriptionsClient) DeletePreparer(ctx context.Context, groupID string, subscriptionID string, cacheControl string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (GroupSubscriptionsClient) DeleteResponder ¶
func (client GroupSubscriptionsClient) 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 (GroupSubscriptionsClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
type GroupsClient ¶
type GroupsClient struct {
BaseClient
}
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() GroupsClient
NewGroupsClient creates an instance of the GroupsClient client.
func NewGroupsClientWithBaseURI ¶
func NewGroupsClientWithBaseURI(baseURI string) GroupsClient
NewGroupsClientWithBaseURI creates an instance of the GroupsClient client.
func (GroupsClient) CreateOrUpdate ¶
func (client GroupsClient) CreateOrUpdate(ctx context.Context, groupID string, createManagementGroupRequest CreateManagementGroupRequest, cacheControl string) (result Group, 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.
groupID is management Group ID. createManagementGroupRequest is management group creation parameters. cacheControl is indicates that the request shouldn't utilize any caches.
func (GroupsClient) CreateOrUpdatePreparer ¶
func (client GroupsClient) CreateOrUpdatePreparer(ctx context.Context, groupID string, createManagementGroupRequest CreateManagementGroupRequest, cacheControl string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (GroupsClient) CreateOrUpdateResponder ¶
func (client GroupsClient) CreateOrUpdateResponder(resp *http.Response) (result Group, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (GroupsClient) CreateOrUpdateSender ¶
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (GroupsClient) Delete ¶
func (client GroupsClient) 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.
groupID is management Group ID. cacheControl is indicates that the request shouldn't utilize any caches.
func (GroupsClient) DeletePreparer ¶
func (client GroupsClient) DeletePreparer(ctx context.Context, groupID string, cacheControl string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (GroupsClient) DeleteResponder ¶
func (client GroupsClient) 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 (GroupsClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (GroupsClient) Get ¶
func (client GroupsClient) Get(ctx context.Context, groupID string, expand string, recurse *bool, cacheControl string) (result Group, err error)
Get get the details of the management group.
groupID is management Group ID. 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. cacheControl is indicates that the request shouldn't utilize any caches.
func (GroupsClient) GetPreparer ¶
func (client GroupsClient) GetPreparer(ctx context.Context, groupID string, expand string, recurse *bool, cacheControl string) (*http.Request, error)
GetPreparer prepares the Get request.
func (GroupsClient) GetResponder ¶
func (client GroupsClient) GetResponder(resp *http.Response) (result Group, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (GroupsClient) GetSender ¶
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(ctx context.Context, cacheControl string, skiptoken string) (result GroupListResultPage, err error)
List list management groups for the authenticated user.
cacheControl is indicates that the request shouldn't utilize any caches. 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(ctx context.Context, cacheControl string, skiptoken string) (result GroupListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (GroupsClient) ListPreparer ¶
func (client GroupsClient) ListPreparer(ctx context.Context, cacheControl string, 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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (GroupsClient) Update ¶
func (client GroupsClient) Update(ctx context.Context, groupID string, createManagementGroupRequest CreateManagementGroupRequest, cacheControl string) (result Group, err error)
Update update a management group.
groupID is management Group ID. createManagementGroupRequest is management group creation parameters. cacheControl is indicates that the request shouldn't utilize any caches.
func (GroupsClient) UpdatePreparer ¶
func (client GroupsClient) UpdatePreparer(ctx context.Context, groupID string, createManagementGroupRequest CreateManagementGroupRequest, cacheControl string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (GroupsClient) UpdateResponder ¶
func (client GroupsClient) UpdateResponder(resp *http.Response) (result Group, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (GroupsClient) UpdateSender ¶
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type Operation ¶
type Operation struct { // Name - 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 ¶
type OperationDisplay struct { // Provider - The name of the provider. Provider *string `json:"provider,omitempty"` // Resource - The resource on which the operation is performed. Resource *string `json:"resource,omitempty"` // Operation - The operation that can be performed. Operation *string `json:"operation,omitempty"` // Description - Operation description. Description *string `json:"description,omitempty"` }
OperationDisplay the object that represents the operation.
type OperationListResult ¶
type OperationListResult struct { autorest.Response `json:"-"` // Value - List of operations supported by the Microsoft.Management resource provider. Value *[]Operation `json:"value,omitempty"` // NextLink - URL to get the next set of operation list results if there are any. NextLink *string `json:"nextLink,omitempty"` }
OperationListResult describes the result of the request to list Microsoft.Management operations.
func (OperationListResult) IsEmpty ¶
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type OperationListResultIterator ¶
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
OperationListResultIterator provides access to a complete listing of Operation values.
func (*OperationListResultIterator) Next ¶
func (iter *OperationListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (OperationListResultIterator) NotDone ¶
func (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (OperationListResultIterator) Response ¶
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (OperationListResultIterator) Value ¶
func (iter OperationListResultIterator) Value() Operation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type OperationListResultPage ¶
type OperationListResultPage struct {
// contains filtered or unexported fields
}
OperationListResultPage contains a page of Operation values.
func (*OperationListResultPage) Next ¶
func (page *OperationListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (OperationListResultPage) NotDone ¶
func (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (OperationListResultPage) Response ¶
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (OperationListResultPage) Values ¶
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
OperationsClient is the the Azure Management Groups API enables consolidation of multiple subscriptions/resources into an organizational hierarchy and centrally manage access control, policies, alerting and reporting for those resources.
func NewOperationsClient ¶
func NewOperationsClient() OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI ¶
func NewOperationsClientWithBaseURI(baseURI string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.
func (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all of the available Management REST API operations.
func (OperationsClient) ListComplete ¶
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (OperationsClient) ListPreparer ¶
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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ParentGroupInfo ¶
type ParentGroupInfo struct { // ParentID - The 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.