usersubscription

package
v0.20240604.1114748 Latest Latest
Warning

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

 Go to latest Published: Jun 4, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2023-05-01-preview/usersubscription Documentation

The usersubscription SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2023-05-01-preview).

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/apimanagement/2023-05-01-preview/usersubscription"

Client Initialization

client := usersubscription.NewUserSubscriptionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: UserSubscriptionClient.List

ctx := context.TODO()
id := usersubscription.NewUserID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "userIdValue")

// alternatively `client.List(ctx, id, usersubscription.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, usersubscription.DefaultListOperationOptions())
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 PossibleValuesForSubscriptionState 

func PossibleValuesForSubscriptionState() []string

func ValidateUserID 

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

ValidateUserID checks that 'input' can be parsed as a User ID

Types

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SubscriptionContract
}

type ListOperationOptions 

type ListOperationOptions struct {
	Filter *string
	Skip   *int64
	Top    *int64
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

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

func (ListOperationOptions) ToOData 

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

func (ListOperationOptions) ToQuery 

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SubscriptionContract
}

type SubscriptionContract 

type SubscriptionContract struct {
	Id         *string                         `json:"id,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Properties *SubscriptionContractProperties `json:"properties,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type SubscriptionContractOperationPredicate 

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

func (SubscriptionContractOperationPredicate) Matches 

func (p SubscriptionContractOperationPredicate) Matches(input SubscriptionContract) bool

type SubscriptionContractProperties 

type SubscriptionContractProperties struct {
	AllowTracing     *bool             `json:"allowTracing,omitempty"`
	CreatedDate      *string           `json:"createdDate,omitempty"`
	DisplayName      *string           `json:"displayName,omitempty"`
	EndDate          *string           `json:"endDate,omitempty"`
	ExpirationDate   *string           `json:"expirationDate,omitempty"`
	NotificationDate *string           `json:"notificationDate,omitempty"`
	OwnerId          *string           `json:"ownerId,omitempty"`
	PrimaryKey       *string           `json:"primaryKey,omitempty"`
	Scope            string            `json:"scope"`
	SecondaryKey     *string           `json:"secondaryKey,omitempty"`
	StartDate        *string           `json:"startDate,omitempty"`
	State            SubscriptionState `json:"state"`
	StateComment     *string           `json:"stateComment,omitempty"`
}

func (*SubscriptionContractProperties) GetCreatedDateAsTime 

func (o *SubscriptionContractProperties) GetCreatedDateAsTime() (*time.Time, error)

func (*SubscriptionContractProperties) GetEndDateAsTime 

func (o *SubscriptionContractProperties) GetEndDateAsTime() (*time.Time, error)

func (*SubscriptionContractProperties) GetExpirationDateAsTime 

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

func (*SubscriptionContractProperties) GetNotificationDateAsTime 

func (o *SubscriptionContractProperties) GetNotificationDateAsTime() (*time.Time, error)

func (*SubscriptionContractProperties) GetStartDateAsTime 

func (o *SubscriptionContractProperties) GetStartDateAsTime() (*time.Time, error)

func (*SubscriptionContractProperties) SetCreatedDateAsTime 

func (o *SubscriptionContractProperties) SetCreatedDateAsTime(input time.Time)

func (*SubscriptionContractProperties) SetEndDateAsTime 

func (o *SubscriptionContractProperties) SetEndDateAsTime(input time.Time)

func (*SubscriptionContractProperties) SetExpirationDateAsTime 

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

func (*SubscriptionContractProperties) SetNotificationDateAsTime 

func (o *SubscriptionContractProperties) SetNotificationDateAsTime(input time.Time)

func (*SubscriptionContractProperties) SetStartDateAsTime 

func (o *SubscriptionContractProperties) SetStartDateAsTime(input time.Time)

type SubscriptionState 

type SubscriptionState string
const (
	SubscriptionStateActive    SubscriptionState = "active"
	SubscriptionStateCancelled SubscriptionState = "cancelled"
	SubscriptionStateExpired   SubscriptionState = "expired"
	SubscriptionStateRejected  SubscriptionState = "rejected"
	SubscriptionStateSubmitted SubscriptionState = "submitted"
	SubscriptionStateSuspended SubscriptionState = "suspended"
)

func (*SubscriptionState) UnmarshalJSON 

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

type UserId 

type UserId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	UserId            string
}

UserId is a struct representing the Resource ID for a User

func NewUserID 

func NewUserID(subscriptionId string, resourceGroupName string, serviceName string, userId string) UserId

NewUserID returns a new UserId struct

func ParseUserID 

func ParseUserID(input string) (*UserId, error)

ParseUserID parses 'input' into a UserId

func ParseUserIDInsensitively 

func ParseUserIDInsensitively(input string) (*UserId, error)

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

func (*UserId) FromParseResult 

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

func (UserId) ID 

func (id UserId) ID() string

ID returns the formatted User ID

func (UserId) Segments 

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

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

func (UserId) String 

func (id UserId) String() string

String returns a human-readable description of this User ID

type UserSubscriptionClient 

type UserSubscriptionClient struct {
	Client *resourcemanager.Client
}

func NewUserSubscriptionClientWithBaseURI 

func NewUserSubscriptionClientWithBaseURI(sdkApi sdkEnv.Api) (*UserSubscriptionClient, error)

func (UserSubscriptionClient) List 

func (c UserSubscriptionClient) List(ctx context.Context, id UserId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (UserSubscriptionClient) ListComplete 

func (c UserSubscriptionClient) ListComplete(ctx context.Context, id UserId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (UserSubscriptionClient) ListCompleteMatchingPredicate 

func (c UserSubscriptionClient) ListCompleteMatchingPredicate(ctx context.Context, id UserId, options ListOperationOptions, predicate SubscriptionContractOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.