README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/datashare/2019-11-01/consumerinvitation
Documentation
The consumerinvitation
SDK allows for interaction with the Azure Resource Manager Service datashare
(API Version 2019-11-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/2019-11-01/consumerinvitation"
Client Initialization
client := consumerinvitation.NewConsumerInvitationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: ConsumerInvitationClient.Get
ctx := context.TODO()
id := consumerinvitation.NewConsumerInvitationID("locationValue", "invitationIdValue")
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: ConsumerInvitationClient.ListInvitations
ctx := context.TODO()
// alternatively `client.ListInvitations(ctx)` can be used to do batched pagination
items, err := client.ListInvitationsComplete(ctx)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: ConsumerInvitationClient.RejectInvitation
ctx := context.TODO()
id := consumerinvitation.NewLocationID("locationValue")
payload := consumerinvitation.ConsumerInvitation{
// ...
}
read, err := client.RejectInvitation(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func PossibleValuesForInvitationStatus() []string
- func ValidateConsumerInvitationID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
- type ConsumerInvitation
- type ConsumerInvitationClient
- func (c ConsumerInvitationClient) Get(ctx context.Context, id ConsumerInvitationId) (result GetOperationResponse, err error)
- func (c ConsumerInvitationClient) ListInvitations(ctx context.Context) (resp ListInvitationsOperationResponse, err error)
- func (c ConsumerInvitationClient) ListInvitationsComplete(ctx context.Context) (ListInvitationsCompleteResult, error)
- func (c ConsumerInvitationClient) ListInvitationsCompleteMatchingPredicate(ctx context.Context, predicate ConsumerInvitationOperationPredicate) (resp ListInvitationsCompleteResult, err error)
- func (c ConsumerInvitationClient) RejectInvitation(ctx context.Context, id LocationId, input ConsumerInvitation) (result RejectInvitationOperationResponse, err error)
- type ConsumerInvitationId
- type ConsumerInvitationOperationPredicate
- type ConsumerInvitationProperties
- func (o *ConsumerInvitationProperties) GetRespondedAtAsTime() (*time.Time, error)
- func (o *ConsumerInvitationProperties) GetSentAtAsTime() (*time.Time, error)
- func (o *ConsumerInvitationProperties) SetRespondedAtAsTime(input time.Time)
- func (o *ConsumerInvitationProperties) SetSentAtAsTime(input time.Time)
- type GetOperationResponse
- type InvitationStatus
- type ListInvitationsCompleteResult
- type ListInvitationsOperationResponse
- type LocationId
- type RejectInvitationOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForInvitationStatus ¶
func PossibleValuesForInvitationStatus() []string
func ValidateConsumerInvitationID ¶
func ValidateConsumerInvitationID(input interface{}, key string) (warnings []string, errors []error)
ValidateConsumerInvitationID checks that 'input' can be parsed as a Consumer Invitation ID
func ValidateLocationID ¶
ValidateLocationID checks that 'input' can be parsed as a Location ID
Types ¶
type ConsumerInvitation ¶
type ConsumerInvitation struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties ConsumerInvitationProperties `json:"properties"` Type *string `json:"type,omitempty"` }
type ConsumerInvitationClient ¶
type ConsumerInvitationClient struct { Client autorest.Client // contains filtered or unexported fields }
func NewConsumerInvitationClientWithBaseURI ¶
func NewConsumerInvitationClientWithBaseURI(endpoint string) ConsumerInvitationClient
func (ConsumerInvitationClient) Get ¶
func (c ConsumerInvitationClient) Get(ctx context.Context, id ConsumerInvitationId) (result GetOperationResponse, err error)
Get ...
func (ConsumerInvitationClient) ListInvitations ¶
func (c ConsumerInvitationClient) ListInvitations(ctx context.Context) (resp ListInvitationsOperationResponse, err error)
ListInvitations ...
func (ConsumerInvitationClient) ListInvitationsComplete ¶
func (c ConsumerInvitationClient) ListInvitationsComplete(ctx context.Context) (ListInvitationsCompleteResult, error)
ListInvitationsComplete retrieves all of the results into a single object
func (ConsumerInvitationClient) ListInvitationsCompleteMatchingPredicate ¶
func (c ConsumerInvitationClient) ListInvitationsCompleteMatchingPredicate(ctx context.Context, predicate ConsumerInvitationOperationPredicate) (resp ListInvitationsCompleteResult, err error)
ListInvitationsCompleteMatchingPredicate retrieves all of the results and then applied the predicate
func (ConsumerInvitationClient) RejectInvitation ¶
func (c ConsumerInvitationClient) RejectInvitation(ctx context.Context, id LocationId, input ConsumerInvitation) (result RejectInvitationOperationResponse, err error)
RejectInvitation ...
type ConsumerInvitationId ¶
ConsumerInvitationId is a struct representing the Resource ID for a Consumer Invitation
func NewConsumerInvitationID ¶
func NewConsumerInvitationID(locationName string, invitationId string) ConsumerInvitationId
NewConsumerInvitationID returns a new ConsumerInvitationId struct
func ParseConsumerInvitationID ¶
func ParseConsumerInvitationID(input string) (*ConsumerInvitationId, error)
ParseConsumerInvitationID parses 'input' into a ConsumerInvitationId
func ParseConsumerInvitationIDInsensitively ¶
func ParseConsumerInvitationIDInsensitively(input string) (*ConsumerInvitationId, error)
ParseConsumerInvitationIDInsensitively parses 'input' case-insensitively into a ConsumerInvitationId note: this method should only be used for API response data and not user input
func (*ConsumerInvitationId) FromParseResult ¶ added in v0.20231127.1171502
func (id *ConsumerInvitationId) FromParseResult(input resourceids.ParseResult) error
func (ConsumerInvitationId) ID ¶
func (id ConsumerInvitationId) ID() string
ID returns the formatted Consumer Invitation ID
func (ConsumerInvitationId) Segments ¶
func (id ConsumerInvitationId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Consumer Invitation ID
func (ConsumerInvitationId) String ¶
func (id ConsumerInvitationId) String() string
String returns a human-readable description of this Consumer Invitation ID
type ConsumerInvitationOperationPredicate ¶
func (ConsumerInvitationOperationPredicate) Matches ¶
func (p ConsumerInvitationOperationPredicate) Matches(input ConsumerInvitation) bool
type ConsumerInvitationProperties ¶
type ConsumerInvitationProperties struct { DataSetCount *int64 `json:"dataSetCount,omitempty"` Description *string `json:"description,omitempty"` InvitationId string `json:"invitationId"` InvitationStatus *InvitationStatus `json:"invitationStatus,omitempty"` Location *string `json:"location,omitempty"` ProviderEmail *string `json:"providerEmail,omitempty"` ProviderName *string `json:"providerName,omitempty"` ProviderTenantName *string `json:"providerTenantName,omitempty"` RespondedAt *string `json:"respondedAt,omitempty"` SentAt *string `json:"sentAt,omitempty"` TermsOfUse *string `json:"termsOfUse,omitempty"` UserEmail *string `json:"userEmail,omitempty"` UserName *string `json:"userName,omitempty"` }
func (*ConsumerInvitationProperties) GetRespondedAtAsTime ¶
func (o *ConsumerInvitationProperties) GetRespondedAtAsTime() (*time.Time, error)
func (*ConsumerInvitationProperties) GetSentAtAsTime ¶
func (o *ConsumerInvitationProperties) GetSentAtAsTime() (*time.Time, error)
func (*ConsumerInvitationProperties) SetRespondedAtAsTime ¶
func (o *ConsumerInvitationProperties) SetRespondedAtAsTime(input time.Time)
func (*ConsumerInvitationProperties) SetSentAtAsTime ¶
func (o *ConsumerInvitationProperties) SetSentAtAsTime(input time.Time)
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response Model *ConsumerInvitation }
type InvitationStatus ¶
type InvitationStatus string
const ( InvitationStatusAccepted InvitationStatus = "Accepted" InvitationStatusPending InvitationStatus = "Pending" InvitationStatusRejected InvitationStatus = "Rejected" InvitationStatusWithdrawn InvitationStatus = "Withdrawn" )
type ListInvitationsCompleteResult ¶
type ListInvitationsCompleteResult struct {
Items []ConsumerInvitation
}
type ListInvitationsOperationResponse ¶
type ListInvitationsOperationResponse struct { HttpResponse *http.Response Model *[]ConsumerInvitation // contains filtered or unexported fields }
func (ListInvitationsOperationResponse) HasMore ¶
func (r ListInvitationsOperationResponse) HasMore() bool
func (ListInvitationsOperationResponse) LoadMore ¶
func (r ListInvitationsOperationResponse) LoadMore(ctx context.Context) (resp ListInvitationsOperationResponse, err error)
type LocationId ¶
type LocationId struct {
LocationName string
}
LocationId is a struct representing the Resource ID for a Location
func NewLocationID ¶
func NewLocationID(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 ¶ added in v0.20231127.1171502
func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
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
type RejectInvitationOperationResponse ¶
type RejectInvitationOperationResponse struct { HttpResponse *http.Response Model *ConsumerInvitation }