users

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2021-08-01/users Documentation

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

Client Initialization

client := users.NewUsersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: UsersClient.UserGenerateSsoUrl

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

read, err := client.UserGenerateSsoUrl(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func ValidateUserID(input interface{}, key string) (warnings []string, errors []error)
• type GenerateSsoUrlResult
• type UserGenerateSsoUrlOperationResponse
• 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
• type UsersClient
  • func NewUsersClientWithBaseURI(endpoint string) UsersClient
  • func (c UsersClient) UserGenerateSsoUrl(ctx context.Context, id UserId) (result UserGenerateSsoUrlOperationResponse, err error)

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 GenerateSsoUrlResult

type GenerateSsoUrlResult struct {
	Value *string `json:"value,omitempty"`
}

type UserGenerateSsoUrlOperationResponse

type UserGenerateSsoUrlOperationResponse struct {
	HttpResponse *http.Response
	Model        *GenerateSsoUrlResult
}

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

type UsersClient

type UsersClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewUsersClientWithBaseURI

func NewUsersClientWithBaseURI(endpoint string) UsersClient

func (UsersClient) UserGenerateSsoUrl

func (c UsersClient) UserGenerateSsoUrl(ctx context.Context, id UserId) (result UserGenerateSsoUrlOperationResponse, err error)

UserGenerateSsoUrl ...