useridentity

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2023-05-01-preview/useridentity Documentation

The useridentity SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2023-05-01-preview).

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/2023-05-01-preview/useridentity"

Client Initialization

client := useridentity.NewUserIdentityClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: UserIdentityClient.UserIdentitiesList

ctx := context.TODO()
id := useridentity.NewUserID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "userId")

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

Documentation

Index

• func ValidateUserID(input interface{}, key string) (warnings []string, errors []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) FromParseResult(input resourceids.ParseResult) error
  • func (id UserId) ID() string
  • func (id UserId) Segments() []resourceids.Segment
  • func (id UserId) String() string
• type UserIdentitiesListCompleteResult
• type UserIdentitiesListCustomPager
  • func (p *UserIdentitiesListCustomPager) NextPageLink() *odata.Link
• type UserIdentitiesListOperationResponse
• type UserIdentityClient
  • func NewUserIdentityClientWithBaseURI(sdkApi sdkEnv.Api) (*UserIdentityClient, error)
  • func (c UserIdentityClient) UserIdentitiesList(ctx context.Context, id UserId) (result UserIdentitiesListOperationResponse, err error)
  • func (c UserIdentityClient) UserIdentitiesListComplete(ctx context.Context, id UserId) (UserIdentitiesListCompleteResult, error)
  • func (c UserIdentityClient) UserIdentitiesListCompleteMatchingPredicate(ctx context.Context, id UserId, ...) (result UserIdentitiesListCompleteResult, err error)
• type UserIdentityContract
• type UserIdentityContractOperationPredicate
  • func (p UserIdentityContractOperationPredicate) Matches(input UserIdentityContract) bool

Functions

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 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) FromParseResult

func (id *UserId) FromParseResult(input resourceids.ParseResult) error

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

type UserIdentitiesListCompleteResult

type UserIdentitiesListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []UserIdentityContract
}

type UserIdentitiesListCustomPager

type UserIdentitiesListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*UserIdentitiesListCustomPager) NextPageLink

func (p *UserIdentitiesListCustomPager) NextPageLink() *odata.Link

type UserIdentitiesListOperationResponse

type UserIdentitiesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]UserIdentityContract
}

type UserIdentityClient

type UserIdentityClient struct {
	Client *resourcemanager.Client
}

func NewUserIdentityClientWithBaseURI

func NewUserIdentityClientWithBaseURI(sdkApi sdkEnv.Api) (*UserIdentityClient, error)

func (UserIdentityClient) UserIdentitiesList

func (c UserIdentityClient) UserIdentitiesList(ctx context.Context, id UserId) (result UserIdentitiesListOperationResponse, err error)

UserIdentitiesList ...

func (UserIdentityClient) UserIdentitiesListComplete

func (c UserIdentityClient) UserIdentitiesListComplete(ctx context.Context, id UserId) (UserIdentitiesListCompleteResult, error)

UserIdentitiesListComplete retrieves all the results into a single object

func (UserIdentityClient) UserIdentitiesListCompleteMatchingPredicate

func (c UserIdentityClient) UserIdentitiesListCompleteMatchingPredicate(ctx context.Context, id UserId, predicate UserIdentityContractOperationPredicate) (result UserIdentitiesListCompleteResult, err error)

UserIdentitiesListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type UserIdentityContract

type UserIdentityContract struct {
	Id       *string `json:"id,omitempty"`
	Provider *string `json:"provider,omitempty"`
}

type UserIdentityContractOperationPredicate

type UserIdentityContractOperationPredicate struct {
	Id       *string
	Provider *string
}

func (UserIdentityContractOperationPredicate) Matches

func (p UserIdentityContractOperationPredicate) Matches(input UserIdentityContract) bool