localusers

package
v0.20221024.1202112 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 24, 2022 License: MPL-2.0 Imports: 8 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/storage/2022-05-01/localusers Documentation

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

Client Initialization

client := localusers.NewLocalUsersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: LocalUsersClient.CreateOrUpdate

ctx := context.TODO()
id := localusers.NewLocalUserID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "usernameValue")

payload := localusers.LocalUser{
	// ...
}


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

Example Usage: LocalUsersClient.Delete

ctx := context.TODO()
id := localusers.NewLocalUserID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "usernameValue")

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

Example Usage: LocalUsersClient.Get

ctx := context.TODO()
id := localusers.NewLocalUserID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "usernameValue")

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

Example Usage: LocalUsersClient.List

ctx := context.TODO()
id := localusers.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

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

Example Usage: LocalUsersClient.ListKeys

ctx := context.TODO()
id := localusers.NewLocalUserID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "usernameValue")

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

Example Usage: LocalUsersClient.RegeneratePassword

ctx := context.TODO()
id := localusers.NewLocalUserID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "usernameValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateLocalUserID 

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

ValidateLocalUserID checks that 'input' can be parsed as a Local User ID

func ValidateStorageAccountID 

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

ValidateStorageAccountID checks that 'input' can be parsed as a Storage Account ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *LocalUser
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *LocalUser
}

type ListKeysOperationResponse 

type ListKeysOperationResponse struct {
	HttpResponse *http.Response
	Model        *LocalUserKeys
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *LocalUsers
}

type LocalUser 

type LocalUser struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *LocalUserProperties   `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type LocalUserId 

type LocalUserId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
	Username          string
}

LocalUserId is a struct representing the Resource ID for a Local User

func NewLocalUserID 

func NewLocalUserID(subscriptionId string, resourceGroupName string, accountName string, username string) LocalUserId

NewLocalUserID returns a new LocalUserId struct

func ParseLocalUserID 

func ParseLocalUserID(input string) (*LocalUserId, error)

ParseLocalUserID parses 'input' into a LocalUserId

func ParseLocalUserIDInsensitively 

func ParseLocalUserIDInsensitively(input string) (*LocalUserId, error)

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

func (LocalUserId) ID 

func (id LocalUserId) ID() string

ID returns the formatted Local User ID

func (LocalUserId) Segments 

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

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

func (LocalUserId) String 

func (id LocalUserId) String() string

String returns a human-readable description of this Local User ID

type LocalUserKeys 

type LocalUserKeys struct {
	SharedKey         *string         `json:"sharedKey,omitempty"`
	SshAuthorizedKeys *[]SshPublicKey `json:"sshAuthorizedKeys,omitempty"`
}

type LocalUserProperties 

type LocalUserProperties struct {
	HasSharedKey      *bool              `json:"hasSharedKey,omitempty"`
	HasSshKey         *bool              `json:"hasSshKey,omitempty"`
	HasSshPassword    *bool              `json:"hasSshPassword,omitempty"`
	HomeDirectory     *string            `json:"homeDirectory,omitempty"`
	PermissionScopes  *[]PermissionScope `json:"permissionScopes,omitempty"`
	Sid               *string            `json:"sid,omitempty"`
	SshAuthorizedKeys *[]SshPublicKey    `json:"sshAuthorizedKeys,omitempty"`
}

type LocalUserRegeneratePasswordResult 

type LocalUserRegeneratePasswordResult struct {
	SshPassword *string `json:"sshPassword,omitempty"`
}

type LocalUsers 

type LocalUsers struct {
	Value *[]LocalUser `json:"value,omitempty"`
}

type LocalUsersClient 

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

func NewLocalUsersClientWithBaseURI 

func NewLocalUsersClientWithBaseURI(endpoint string) LocalUsersClient

func (LocalUsersClient) CreateOrUpdate 

func (c LocalUsersClient) CreateOrUpdate(ctx context.Context, id LocalUserId, input LocalUser) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (LocalUsersClient) Delete 

func (c LocalUsersClient) Delete(ctx context.Context, id LocalUserId) (result DeleteOperationResponse, err error)

Delete ...

func (LocalUsersClient) Get 

func (c LocalUsersClient) Get(ctx context.Context, id LocalUserId) (result GetOperationResponse, err error)

Get ...

func (LocalUsersClient) List 

func (c LocalUsersClient) List(ctx context.Context, id StorageAccountId) (result ListOperationResponse, err error)

List ...

func (LocalUsersClient) ListKeys 

func (c LocalUsersClient) ListKeys(ctx context.Context, id LocalUserId) (result ListKeysOperationResponse, err error)

ListKeys ...

func (LocalUsersClient) RegeneratePassword 

func (c LocalUsersClient) RegeneratePassword(ctx context.Context, id LocalUserId) (result RegeneratePasswordOperationResponse, err error)

RegeneratePassword ...

type PermissionScope 

type PermissionScope struct {
	Permissions  string `json:"permissions"`
	ResourceName string `json:"resourceName"`
	Service      string `json:"service"`
}

type RegeneratePasswordOperationResponse 

type RegeneratePasswordOperationResponse struct {
	HttpResponse *http.Response
	Model        *LocalUserRegeneratePasswordResult
}

type SshPublicKey 

type SshPublicKey struct {
	Description *string `json:"description,omitempty"`
	Key         *string `json:"key,omitempty"`
}

type StorageAccountId 

type StorageAccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
}

StorageAccountId is a struct representing the Resource ID for a Storage Account

func NewStorageAccountID 

func NewStorageAccountID(subscriptionId string, resourceGroupName string, accountName string) StorageAccountId

NewStorageAccountID returns a new StorageAccountId struct

func ParseStorageAccountID 

func ParseStorageAccountID(input string) (*StorageAccountId, error)

ParseStorageAccountID parses 'input' into a StorageAccountId

func ParseStorageAccountIDInsensitively 

func ParseStorageAccountIDInsensitively(input string) (*StorageAccountId, error)

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

func (StorageAccountId) ID 

func (id StorageAccountId) ID() string

ID returns the formatted Storage Account ID

func (StorageAccountId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Storage Account ID

func (StorageAccountId) String 

func (id StorageAccountId) String() string

String returns a human-readable description of this Storage Account ID

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.