aadproperties

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2023-01-15/aadproperties Documentation

The aadproperties SDK allows for interaction with the Azure Resource Manager Service recoveryservicesbackup (API Version 2023-01-15).

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/2023-01-15/aadproperties"

Client Initialization

client := aadproperties.NewAadPropertiesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AadPropertiesClient.Get

ctx := context.TODO()
id := aadproperties.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

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

Documentation

Index

• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type AADProperties
• type AADPropertiesResource
• type AadPropertiesClient
  • func NewAadPropertiesClientWithBaseURI(endpoint string) AadPropertiesClient
  • func (c AadPropertiesClient) Get(ctx context.Context, id LocationId, options GetOperationOptions) (result GetOperationResponse, err error)
• type GetOperationOptions
  • func DefaultGetOperationOptions() GetOperationOptions
• type GetOperationResponse
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string

Functions

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type AADProperties

type AADProperties struct {
	Audience                 *string `json:"audience,omitempty"`
	Authority                *string `json:"authority,omitempty"`
	ServicePrincipalClientId *string `json:"servicePrincipalClientId,omitempty"`
	ServicePrincipalObjectId *string `json:"servicePrincipalObjectId,omitempty"`
	TenantId                 *string `json:"tenantId,omitempty"`
}

type AADPropertiesResource

type AADPropertiesResource struct {
	ETag       *string            `json:"eTag,omitempty"`
	Id         *string            `json:"id,omitempty"`
	Location   *string            `json:"location,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties *AADProperties     `json:"properties,omitempty"`
	Tags       *map[string]string `json:"tags,omitempty"`
	Type       *string            `json:"type,omitempty"`
}

type AadPropertiesClient

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

func NewAadPropertiesClientWithBaseURI

func NewAadPropertiesClientWithBaseURI(endpoint string) AadPropertiesClient

func (AadPropertiesClient) Get

func (c AadPropertiesClient) Get(ctx context.Context, id LocationId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

type GetOperationOptions

type GetOperationOptions struct {
	Filter *string
}

func DefaultGetOperationOptions

func DefaultGetOperationOptions() GetOperationOptions

type GetOperationResponse

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

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

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

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID