invitation

package
v0.20240320.1144505 Latest Latest
Warning

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

 Go to latest Published: Mar 20, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/datashare/2021-08-01/invitation Documentation

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

Client Initialization

client := invitation.NewInvitationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: InvitationClient.Create

ctx := context.TODO()
id := invitation.NewInvitationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareValue", "invitationValue")

payload := invitation.Invitation{
	// ...
}


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

Example Usage: InvitationClient.Delete

ctx := context.TODO()
id := invitation.NewInvitationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareValue", "invitationValue")

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: InvitationClient.Get

ctx := context.TODO()
id := invitation.NewInvitationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareValue", "invitationValue")

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: InvitationClient.ListByShare

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

// alternatively `client.ListByShare(ctx, id, invitation.DefaultListByShareOperationOptions())` can be used to do batched pagination
items, err := client.ListByShareComplete(ctx, id, invitation.DefaultListByShareOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForInvitationStatus 

func PossibleValuesForInvitationStatus() []string

func ValidateInvitationID 

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

ValidateInvitationID checks that 'input' can be parsed as a Invitation ID

func ValidateShareID 

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

ValidateShareID checks that 'input' can be parsed as a Share ID

Types

type CreateOperationResponse 

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Invitation
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Invitation
}

type Invitation 

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

type InvitationClient 

type InvitationClient struct {
	Client *resourcemanager.Client
}

func NewInvitationClientWithBaseURI 

func NewInvitationClientWithBaseURI(sdkApi sdkEnv.Api) (*InvitationClient, error)

func (InvitationClient) Create 

func (c InvitationClient) Create(ctx context.Context, id InvitationId, input Invitation) (result CreateOperationResponse, err error)

Create ...

func (InvitationClient) Delete 

func (c InvitationClient) Delete(ctx context.Context, id InvitationId) (result DeleteOperationResponse, err error)

Delete ...

func (InvitationClient) Get 

func (c InvitationClient) Get(ctx context.Context, id InvitationId) (result GetOperationResponse, err error)

Get ...

func (InvitationClient) ListByShare 

func (c InvitationClient) ListByShare(ctx context.Context, id ShareId, options ListByShareOperationOptions) (result ListByShareOperationResponse, err error)

ListByShare ...

func (InvitationClient) ListByShareComplete 

func (c InvitationClient) ListByShareComplete(ctx context.Context, id ShareId, options ListByShareOperationOptions) (ListByShareCompleteResult, error)

ListByShareComplete retrieves all the results into a single object

func (InvitationClient) ListByShareCompleteMatchingPredicate 

func (c InvitationClient) ListByShareCompleteMatchingPredicate(ctx context.Context, id ShareId, options ListByShareOperationOptions, predicate InvitationOperationPredicate) (result ListByShareCompleteResult, err error)

ListByShareCompleteMatchingPredicate retrieves all the results and then applies the predicate

type InvitationId 

type InvitationId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
	ShareName         string
	InvitationName    string
}

InvitationId is a struct representing the Resource ID for a Invitation

func NewInvitationID 

func NewInvitationID(subscriptionId string, resourceGroupName string, accountName string, shareName string, invitationName string) InvitationId

NewInvitationID returns a new InvitationId struct

func ParseInvitationID 

func ParseInvitationID(input string) (*InvitationId, error)

ParseInvitationID parses 'input' into a InvitationId

func ParseInvitationIDInsensitively 

func ParseInvitationIDInsensitively(input string) (*InvitationId, error)

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

func (*InvitationId) FromParseResult 

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

func (InvitationId) ID 

func (id InvitationId) ID() string

ID returns the formatted Invitation ID

func (InvitationId) Segments 

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

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

func (InvitationId) String 

func (id InvitationId) String() string

String returns a human-readable description of this Invitation ID

type InvitationOperationPredicate 

type InvitationOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (InvitationOperationPredicate) Matches 

func (p InvitationOperationPredicate) Matches(input Invitation) bool

type InvitationProperties 

type InvitationProperties struct {
	ExpirationDate          *string           `json:"expirationDate,omitempty"`
	InvitationId            *string           `json:"invitationId,omitempty"`
	InvitationStatus        *InvitationStatus `json:"invitationStatus,omitempty"`
	RespondedAt             *string           `json:"respondedAt,omitempty"`
	SentAt                  *string           `json:"sentAt,omitempty"`
	TargetActiveDirectoryId *string           `json:"targetActiveDirectoryId,omitempty"`
	TargetEmail             *string           `json:"targetEmail,omitempty"`
	TargetObjectId          *string           `json:"targetObjectId,omitempty"`
	UserEmail               *string           `json:"userEmail,omitempty"`
	UserName                *string           `json:"userName,omitempty"`
}

func (*InvitationProperties) GetExpirationDateAsTime 

func (o *InvitationProperties) GetExpirationDateAsTime() (*time.Time, error)

func (*InvitationProperties) GetRespondedAtAsTime 

func (o *InvitationProperties) GetRespondedAtAsTime() (*time.Time, error)

func (*InvitationProperties) GetSentAtAsTime 

func (o *InvitationProperties) GetSentAtAsTime() (*time.Time, error)

func (*InvitationProperties) SetExpirationDateAsTime 

func (o *InvitationProperties) SetExpirationDateAsTime(input time.Time)

func (*InvitationProperties) SetRespondedAtAsTime 

func (o *InvitationProperties) SetRespondedAtAsTime(input time.Time)

func (*InvitationProperties) SetSentAtAsTime 

func (o *InvitationProperties) SetSentAtAsTime(input time.Time)

type InvitationStatus 

type InvitationStatus string
const (
	InvitationStatusAccepted  InvitationStatus = "Accepted"
	InvitationStatusPending   InvitationStatus = "Pending"
	InvitationStatusRejected  InvitationStatus = "Rejected"
	InvitationStatusWithdrawn InvitationStatus = "Withdrawn"
)

func (*InvitationStatus) UnmarshalJSON 

func (s *InvitationStatus) UnmarshalJSON(bytes []byte) error

type ListByShareCompleteResult 

type ListByShareCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Invitation
}

type ListByShareOperationOptions 

type ListByShareOperationOptions struct {
	Filter  *string
	Orderby *string
}

func DefaultListByShareOperationOptions 

func DefaultListByShareOperationOptions() ListByShareOperationOptions

func (ListByShareOperationOptions) ToHeaders 

func (o ListByShareOperationOptions) ToHeaders() *client.Headers

func (ListByShareOperationOptions) ToOData 

func (o ListByShareOperationOptions) ToOData() *odata.Query

func (ListByShareOperationOptions) ToQuery 

func (o ListByShareOperationOptions) ToQuery() *client.QueryParams

type ListByShareOperationResponse 

type ListByShareOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Invitation
}

type ShareId 

type ShareId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
	ShareName         string
}

ShareId is a struct representing the Resource ID for a Share

func NewShareID 

func NewShareID(subscriptionId string, resourceGroupName string, accountName string, shareName string) ShareId

NewShareID returns a new ShareId struct

func ParseShareID 

func ParseShareID(input string) (*ShareId, error)

ParseShareID parses 'input' into a ShareId

func ParseShareIDInsensitively 

func ParseShareIDInsensitively(input string) (*ShareId, error)

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

func (*ShareId) FromParseResult 

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

func (ShareId) ID 

func (id ShareId) ID() string

ID returns the formatted Share ID

func (ShareId) Segments 

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

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

func (ShareId) String 

func (id ShareId) String() string

String returns a human-readable description of this Share 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.