entities

README

github.com/hashicorp/go-azure-sdk/resource-manager/managementgroups/2021-04-01/entities Documentation

The entities SDK allows for interaction with the Azure Resource Manager Service managementgroups (API Version 2021-04-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/managementgroups/2021-04-01/entities"

Client Initialization

client := entities.NewEntitiesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EntitiesClient.List

ctx := context.TODO()


// alternatively `client.List(ctx, entities.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, entities.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func PossibleValuesForEntitySearchType() []string
• func PossibleValuesForEntityViewParameterType() []string
• func PossibleValuesForPermissions() []string
• type EntitiesClient
  • func NewEntitiesClientWithBaseURI(sdkApi sdkEnv.Api) (*EntitiesClient, error)
  • func (c EntitiesClient) List(ctx context.Context, options ListOperationOptions) (result ListOperationResponse, err error)
  • func (c EntitiesClient) ListComplete(ctx context.Context, options ListOperationOptions) (ListCompleteResult, error)
  • func (c EntitiesClient) ListCompleteMatchingPredicate(ctx context.Context, options ListOperationOptions, ...) (result ListCompleteResult, err error)
• type EntityInfo
• type EntityInfoOperationPredicate
  • func (p EntityInfoOperationPredicate) Matches(input EntityInfo) bool
• type EntityInfoProperties
• type EntityParentGroupInfo
• type EntitySearchType
  • func (s *EntitySearchType) UnmarshalJSON(bytes []byte) error
• type EntityViewParameterType
  • func (s *EntityViewParameterType) UnmarshalJSON(bytes []byte) error
• type ListCompleteResult
• type ListOperationOptions
  • func DefaultListOperationOptions() ListOperationOptions
  • func (o ListOperationOptions) ToHeaders() *client.Headers
  • func (o ListOperationOptions) ToOData() *odata.Query
  • func (o ListOperationOptions) ToQuery() *client.QueryParams
• type ListOperationResponse
• type Permissions
  • func (s *Permissions) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForEntitySearchType

func PossibleValuesForEntitySearchType() []string

func PossibleValuesForEntityViewParameterType

func PossibleValuesForEntityViewParameterType() []string

func PossibleValuesForPermissions

func PossibleValuesForPermissions() []string

Types

type EntitiesClient

type EntitiesClient struct {
	Client *resourcemanager.Client
}

func NewEntitiesClientWithBaseURI

func NewEntitiesClientWithBaseURI(sdkApi sdkEnv.Api) (*EntitiesClient, error)

func (EntitiesClient) List

func (c EntitiesClient) List(ctx context.Context, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (EntitiesClient) ListComplete

func (c EntitiesClient) ListComplete(ctx context.Context, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (EntitiesClient) ListCompleteMatchingPredicate

func (c EntitiesClient) ListCompleteMatchingPredicate(ctx context.Context, options ListOperationOptions, predicate EntityInfoOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type EntityInfo

type EntityInfo struct {
	Id         *string               `json:"id,omitempty"`
	Name       *string               `json:"name,omitempty"`
	Properties *EntityInfoProperties `json:"properties,omitempty"`
	Type       *string               `json:"type,omitempty"`
}

type EntityInfoOperationPredicate

type EntityInfoOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (EntityInfoOperationPredicate) Matches

func (p EntityInfoOperationPredicate) Matches(input EntityInfo) bool

type EntityInfoProperties

type EntityInfoProperties struct {
	DisplayName            *string                `json:"displayName,omitempty"`
	InheritedPermissions   *Permissions           `json:"inheritedPermissions,omitempty"`
	NumberOfChildGroups    *int64                 `json:"numberOfChildGroups,omitempty"`
	NumberOfChildren       *int64                 `json:"numberOfChildren,omitempty"`
	NumberOfDescendants    *int64                 `json:"numberOfDescendants,omitempty"`
	Parent                 *EntityParentGroupInfo `json:"parent,omitempty"`
	ParentDisplayNameChain *[]string              `json:"parentDisplayNameChain,omitempty"`
	ParentNameChain        *[]string              `json:"parentNameChain,omitempty"`
	Permissions            *Permissions           `json:"permissions,omitempty"`
	TenantId               *string                `json:"tenantId,omitempty"`
}

type EntityParentGroupInfo

type EntityParentGroupInfo struct {
	Id *string `json:"id,omitempty"`
}

type EntitySearchType

type EntitySearchType string

const (
	EntitySearchTypeAllowedChildren             EntitySearchType = "AllowedChildren"
	EntitySearchTypeAllowedParents              EntitySearchType = "AllowedParents"
	EntitySearchTypeChildrenOnly                EntitySearchType = "ChildrenOnly"
	EntitySearchTypeParentAndFirstLevelChildren EntitySearchType = "ParentAndFirstLevelChildren"
	EntitySearchTypeParentOnly                  EntitySearchType = "ParentOnly"
)

func (*EntitySearchType) UnmarshalJSON

func (s *EntitySearchType) UnmarshalJSON(bytes []byte) error

type EntityViewParameterType

type EntityViewParameterType string

const (
	EntityViewParameterTypeAudit             EntityViewParameterType = "Audit"
	EntityViewParameterTypeFullHierarchy     EntityViewParameterType = "FullHierarchy"
	EntityViewParameterTypeGroupsOnly        EntityViewParameterType = "GroupsOnly"
	EntityViewParameterTypeSubscriptionsOnly EntityViewParameterType = "SubscriptionsOnly"
)

func (*EntityViewParameterType) UnmarshalJSON

func (s *EntityViewParameterType) UnmarshalJSON(bytes []byte) error

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []EntityInfo
}

type ListOperationOptions

type ListOperationOptions struct {
	CacheControl *string
	Filter       *string
	GroupName    *string
	Search       *EntitySearchType
	Select       *string
	Skip         *int64
	Top          *int64
	View         *EntityViewParameterType
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]EntityInfo
}

type Permissions

type Permissions string

const (
	PermissionsDelete   Permissions = "delete"
	PermissionsEdit     Permissions = "edit"
	PermissionsNoaccess Permissions = "noaccess"
	PermissionsView     Permissions = "view"
)

func (*Permissions) UnmarshalJSON

func (s *Permissions) UnmarshalJSON(bytes []byte) error