usergroup

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/usergroup Documentation

The usergroup SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2022-08-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/apimanagement/2022-08-01/usergroup"

Client Initialization

client := usergroup.NewUserGroupClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: UserGroupClient.List

ctx := context.TODO()
id := usergroup.NewUserID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "userIdValue")

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

Documentation

Index

• func PossibleValuesForGroupType() []string
• func ValidateUserID(input interface{}, key string) (warnings []string, errors []error)
• type GroupContract
• type GroupContractOperationPredicate
  • func (p GroupContractOperationPredicate) Matches(input GroupContract) bool
• type GroupContractProperties
• type GroupType
  • func (s *GroupType) 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 UserGroupClient
  • func NewUserGroupClientWithBaseURI(sdkApi sdkEnv.Api) (*UserGroupClient, error)
  • func (c UserGroupClient) List(ctx context.Context, id UserId, options ListOperationOptions) (result ListOperationResponse, err error)
  • func (c UserGroupClient) ListComplete(ctx context.Context, id UserId, options ListOperationOptions) (ListCompleteResult, error)
  • func (c UserGroupClient) ListCompleteMatchingPredicate(ctx context.Context, id UserId, options ListOperationOptions, ...) (result ListCompleteResult, err error)
• type UserId
  • func NewUserID(subscriptionId string, resourceGroupName string, serviceName string, ...) UserId
  • func ParseUserID(input string) (*UserId, error)
  • func ParseUserIDInsensitively(input string) (*UserId, error)
  • func (id UserId) ID() string
  • func (id UserId) Segments() []resourceids.Segment
  • func (id UserId) String() string

Functions

func PossibleValuesForGroupType

func PossibleValuesForGroupType() []string

func ValidateUserID

func ValidateUserID(input interface{}, key string) (warnings []string, errors []error)

ValidateUserID checks that 'input' can be parsed as a User ID

Types

type GroupContract

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

type GroupContractOperationPredicate

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

func (GroupContractOperationPredicate) Matches

func (p GroupContractOperationPredicate) Matches(input GroupContract) bool

type GroupContractProperties

type GroupContractProperties struct {
	BuiltIn     *bool      `json:"builtIn,omitempty"`
	Description *string    `json:"description,omitempty"`
	DisplayName string     `json:"displayName"`
	ExternalId  *string    `json:"externalId,omitempty"`
	Type        *GroupType `json:"type,omitempty"`
}

type GroupType

type GroupType string

const (
	GroupTypeCustom   GroupType = "custom"
	GroupTypeExternal GroupType = "external"
	GroupTypeSystem   GroupType = "system"
)

func (*GroupType) UnmarshalJSON

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []GroupContract
}

type ListOperationOptions

type ListOperationOptions struct {
	Filter *string
	Skip   *int64
	Top    *int64
}

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        *[]GroupContract
}

type UserGroupClient

type UserGroupClient struct {
	Client *resourcemanager.Client
}

func NewUserGroupClientWithBaseURI

func NewUserGroupClientWithBaseURI(sdkApi sdkEnv.Api) (*UserGroupClient, error)

func (UserGroupClient) List

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

List ...

func (UserGroupClient) ListComplete

func (c UserGroupClient) ListComplete(ctx context.Context, id UserId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (UserGroupClient) ListCompleteMatchingPredicate

func (c UserGroupClient) ListCompleteMatchingPredicate(ctx context.Context, id UserId, options ListOperationOptions, predicate GroupContractOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type UserId

type UserId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	UserId            string
}

UserId is a struct representing the Resource ID for a User

func NewUserID

func NewUserID(subscriptionId string, resourceGroupName string, serviceName string, userId string) UserId

NewUserID returns a new UserId struct

func ParseUserID

func ParseUserID(input string) (*UserId, error)

ParseUserID parses 'input' into a UserId

func ParseUserIDInsensitively

func ParseUserIDInsensitively(input string) (*UserId, error)

ParseUserIDInsensitively parses 'input' case-insensitively into a UserId note: this method should only be used for API response data and not user input

func (UserId) ID

func (id UserId) ID() string

ID returns the formatted User ID

func (UserId) Segments

func (id UserId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this User ID

func (UserId) String

func (id UserId) String() string

String returns a human-readable description of this User ID