securitypins

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2024-04-01/securitypins Documentation

The securitypins SDK allows for interaction with the Azure Resource Manager Service recoveryservicesbackup (API Version 2024-04-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/recoveryservicesbackup/2024-04-01/securitypins"

Client Initialization

client := securitypins.NewSecurityPINsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SecurityPINsClient.Get

ctx := context.TODO()
id := securitypins.NewVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue")

payload := securitypins.SecurityPinBase{
	// ...
}


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

Documentation

Index

• func ValidateVaultID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationOptions
  • func DefaultGetOperationOptions() GetOperationOptions
• type GetOperationResponse
• type SecurityPINsClient
  • func NewSecurityPINsClientWithBaseURI(endpoint string) SecurityPINsClient
  • func (c SecurityPINsClient) Get(ctx context.Context, id VaultId, input SecurityPinBase, ...) (result GetOperationResponse, err error)
• type SecurityPinBase
• type TokenInformation
• type VaultId
  • func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId
  • func ParseVaultID(input string) (*VaultId, error)
  • func ParseVaultIDInsensitively(input string) (*VaultId, error)
  • func (id *VaultId) FromParseResult(input resourceids.ParseResult) error
  • func (id VaultId) ID() string
  • func (id VaultId) Segments() []resourceids.Segment
  • func (id VaultId) String() string

Functions

func ValidateVaultID

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

ValidateVaultID checks that 'input' can be parsed as a Vault ID

Types

type GetOperationOptions

type GetOperationOptions struct {
	XMsAuthorizationAuxiliary *string
}

func DefaultGetOperationOptions

func DefaultGetOperationOptions() GetOperationOptions

type GetOperationResponse

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

type SecurityPINsClient

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

func NewSecurityPINsClientWithBaseURI

func NewSecurityPINsClientWithBaseURI(endpoint string) SecurityPINsClient

func (SecurityPINsClient) Get

func (c SecurityPINsClient) Get(ctx context.Context, id VaultId, input SecurityPinBase, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

type SecurityPinBase

type SecurityPinBase struct {
	ResourceGuardOperationRequests *[]string `json:"resourceGuardOperationRequests,omitempty"`
}

type TokenInformation

type TokenInformation struct {
	ExpiryTimeInUtcTicks *int64  `json:"expiryTimeInUtcTicks,omitempty"`
	SecurityPIN          *string `json:"securityPIN,omitempty"`
	Token                *string `json:"token,omitempty"`
}

type VaultId

type VaultId struct {
	SubscriptionId    string
	ResourceGroupName string
	VaultName         string
}

VaultId is a struct representing the Resource ID for a Vault

func NewVaultID

func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId

NewVaultID returns a new VaultId struct

func ParseVaultID

func ParseVaultID(input string) (*VaultId, error)

ParseVaultID parses 'input' into a VaultId

func ParseVaultIDInsensitively

func ParseVaultIDInsensitively(input string) (*VaultId, error)

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

func (*VaultId) FromParseResult

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

func (VaultId) ID

func (id VaultId) ID() string

ID returns the formatted Vault ID

func (VaultId) Segments

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

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

func (VaultId) String

func (id VaultId) String() string

String returns a human-readable description of this Vault ID