README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/storage/2023-01-01/localusers
Documentation
The localusers
SDK allows for interaction with Azure Resource Manager storage
(API Version 2023-01-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/storage/2023-01-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", "storageAccountName", "localUserName")
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", "storageAccountName", "localUserName")
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", "storageAccountName", "localUserName")
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 := commonids.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountName")
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", "storageAccountName", "localUserName")
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", "storageAccountName", "localUserName")
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 ¶
- func ValidateLocalUserID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListKeysOperationResponse
- type ListOperationResponse
- type LocalUser
- type LocalUserId
- type LocalUserKeys
- type LocalUserProperties
- type LocalUserRegeneratePasswordResult
- type LocalUsers
- type LocalUsersClient
- func (c LocalUsersClient) CreateOrUpdate(ctx context.Context, id LocalUserId, input LocalUser) (result CreateOrUpdateOperationResponse, err error)
- func (c LocalUsersClient) Delete(ctx context.Context, id LocalUserId) (result DeleteOperationResponse, err error)
- func (c LocalUsersClient) Get(ctx context.Context, id LocalUserId) (result GetOperationResponse, err error)
- func (c LocalUsersClient) List(ctx context.Context, id commonids.StorageAccountId) (result ListOperationResponse, err error)
- func (c LocalUsersClient) ListKeys(ctx context.Context, id LocalUserId) (result ListKeysOperationResponse, err error)
- func (c LocalUsersClient) RegeneratePassword(ctx context.Context, id LocalUserId) (result RegeneratePasswordOperationResponse, err error)
- type PermissionScope
- type RegeneratePasswordOperationResponse
- type SshPublicKey
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateLocalUserID ¶
ValidateLocalUserID checks that 'input' can be parsed as a Local User ID
Types ¶
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type ListKeysOperationResponse ¶
type ListKeysOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *LocalUserKeys }
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response OData *odata.OData 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 StorageAccountName string LocalUserName string }
LocalUserId is a struct representing the Resource ID for a Local User
func NewLocalUserID ¶
func NewLocalUserID(subscriptionId string, resourceGroupName string, storageAccountName string, localUserName 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) FromParseResult ¶
func (id *LocalUserId) FromParseResult(input resourceids.ParseResult) error
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 { SshAuthorizedKeys *[]SshPublicKey `json:"sshAuthorizedKeys,omitempty"` }
type LocalUserProperties ¶
type LocalUserProperties struct { 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 *resourcemanager.Client
}
func NewLocalUsersClientWithBaseURI ¶
func NewLocalUsersClientWithBaseURI(sdkApi sdkEnv.Api) (*LocalUsersClient, error)
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 commonids.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 RegeneratePasswordOperationResponse ¶
type RegeneratePasswordOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *LocalUserRegeneratePasswordResult }
type SshPublicKey ¶
Source Files ¶
- client.go
- id_localuser.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_list.go
- method_listkeys.go
- method_regeneratepassword.go
- model_localuser.go
- model_localuserkeys.go
- model_localuserproperties.go
- model_localuserregeneratepasswordresult.go
- model_localusers.go
- model_permissionscope.go
- model_sshpublickey.go
- version.go