subscription

package
v0.20231101.1150602 Latest Latest
Warning

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

 Go to latest Published: Nov 1, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/subscription Documentation

The subscription SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2022-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/apimanagement/2022-08-01/subscription"

Client Initialization

client := subscription.NewSubscriptionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SubscriptionClient.CreateOrUpdate

ctx := context.TODO()
id := subscription.NewSubscriptions2ID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "subscriptionValue")

payload := subscription.SubscriptionCreateParameters{
	// ...
}


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

Example Usage: SubscriptionClient.Delete

ctx := context.TODO()
id := subscription.NewSubscriptions2ID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "subscriptionValue")

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

Example Usage: SubscriptionClient.Get

ctx := context.TODO()
id := subscription.NewSubscriptions2ID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "subscriptionValue")

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: SubscriptionClient.GetEntityTag

ctx := context.TODO()
id := subscription.NewSubscriptions2ID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "subscriptionValue")

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

Example Usage: SubscriptionClient.List

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

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

Example Usage: SubscriptionClient.ListSecrets

ctx := context.TODO()
id := subscription.NewSubscriptions2ID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "subscriptionValue")

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

Example Usage: SubscriptionClient.RegeneratePrimaryKey

ctx := context.TODO()
id := subscription.NewSubscriptions2ID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "subscriptionValue")

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

Example Usage: SubscriptionClient.RegenerateSecondaryKey

ctx := context.TODO()
id := subscription.NewSubscriptions2ID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "subscriptionValue")

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

Example Usage: SubscriptionClient.Update

ctx := context.TODO()
id := subscription.NewSubscriptions2ID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "subscriptionValue")

payload := subscription.SubscriptionUpdateParameters{
	// ...
}


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

Example Usage: SubscriptionClient.UserSubscriptionGet

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAppType 

func PossibleValuesForAppType() []string

func PossibleValuesForSubscriptionState 

func PossibleValuesForSubscriptionState() []string

func ValidateServiceID 

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

func ValidateSubscriptions2ID 

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

ValidateSubscriptions2ID checks that 'input' can be parsed as a Subscriptions 2 ID

func ValidateUserSubscriptions2ID added in v0.20230727.1090744 

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

ValidateUserSubscriptions2ID checks that 'input' can be parsed as a User Subscriptions 2 ID

Types

type AppType 

type AppType string
const (
	AppTypeDeveloperPortal AppType = "developerPortal"
	AppTypePortal          AppType = "portal"
)

func (*AppType) UnmarshalJSON added in v0.20230801.1071415 

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

type CreateOrUpdateOperationOptions 

type CreateOrUpdateOperationOptions struct {
	AppType *AppType
	IfMatch *string
	Notify  *bool
}

func DefaultCreateOrUpdateOperationOptions 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders added in v0.20230801.1071415 

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

func (CreateOrUpdateOperationOptions) ToOData added in v0.20230801.1071415 

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

func (CreateOrUpdateOperationOptions) ToQuery added in v0.20230801.1071415 

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

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SubscriptionContract
}

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders added in v0.20230801.1071415 

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

func (DeleteOperationOptions) ToOData added in v0.20230801.1071415 

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

func (DeleteOperationOptions) ToQuery added in v0.20230801.1071415 

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

type DeleteOperationResponse 

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

type GetEntityTagOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	Items []SubscriptionContract
}

type ListOperationOptions 

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

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230801.1071415 

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

func (ListOperationOptions) ToOData added in v0.20230801.1071415 

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

func (ListOperationOptions) ToQuery added in v0.20230801.1071415 

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

type ListOperationResponse 

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

type ListSecretsOperationResponse 

type ListSecretsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SubscriptionKeysContract
}

type RegeneratePrimaryKeyOperationResponse 

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

type RegenerateSecondaryKeyOperationResponse 

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

type ServiceId 

type ServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID 

func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID 

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively 

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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

func (ServiceId) ID 

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments 

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

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

func (ServiceId) String 

func (id ServiceId) String() string

String returns a human-readable description of this Service ID

type SubscriptionClient 

type SubscriptionClient struct {
	Client *resourcemanager.Client
}

func NewSubscriptionClientWithBaseURI 

func NewSubscriptionClientWithBaseURI(sdkApi sdkEnv.Api) (*SubscriptionClient, error)

func (SubscriptionClient) CreateOrUpdate 

func (c SubscriptionClient) CreateOrUpdate(ctx context.Context, id Subscriptions2Id, input SubscriptionCreateParameters, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SubscriptionClient) Delete 

func (c SubscriptionClient) Delete(ctx context.Context, id Subscriptions2Id, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (SubscriptionClient) Get 

func (c SubscriptionClient) Get(ctx context.Context, id Subscriptions2Id) (result GetOperationResponse, err error)

Get ...

func (SubscriptionClient) GetEntityTag 

func (c SubscriptionClient) GetEntityTag(ctx context.Context, id Subscriptions2Id) (result GetEntityTagOperationResponse, err error)

GetEntityTag ...

func (SubscriptionClient) List 

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

List ...

func (SubscriptionClient) ListComplete 

func (c SubscriptionClient) ListComplete(ctx context.Context, id ServiceId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (SubscriptionClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SubscriptionClient) ListSecrets 

func (c SubscriptionClient) ListSecrets(ctx context.Context, id Subscriptions2Id) (result ListSecretsOperationResponse, err error)

ListSecrets ...

func (SubscriptionClient) RegeneratePrimaryKey 

func (c SubscriptionClient) RegeneratePrimaryKey(ctx context.Context, id Subscriptions2Id) (result RegeneratePrimaryKeyOperationResponse, err error)

RegeneratePrimaryKey ...

func (SubscriptionClient) RegenerateSecondaryKey 

func (c SubscriptionClient) RegenerateSecondaryKey(ctx context.Context, id Subscriptions2Id) (result RegenerateSecondaryKeyOperationResponse, err error)

RegenerateSecondaryKey ...

func (SubscriptionClient) Update 

func (c SubscriptionClient) Update(ctx context.Context, id Subscriptions2Id, input SubscriptionUpdateParameters, options UpdateOperationOptions) (result UpdateOperationResponse, err error)

Update ...

func (SubscriptionClient) UserSubscriptionGet 

func (c SubscriptionClient) UserSubscriptionGet(ctx context.Context, id UserSubscriptions2Id) (result UserSubscriptionGetOperationResponse, err error)

UserSubscriptionGet ...

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 SubscriptionCreateParameterProperties 

type SubscriptionCreateParameterProperties struct {
	AllowTracing *bool              `json:"allowTracing,omitempty"`
	DisplayName  string             `json:"displayName"`
	OwnerId      *string            `json:"ownerId,omitempty"`
	PrimaryKey   *string            `json:"primaryKey,omitempty"`
	Scope        string             `json:"scope"`
	SecondaryKey *string            `json:"secondaryKey,omitempty"`
	State        *SubscriptionState `json:"state,omitempty"`
}

type SubscriptionCreateParameters 

type SubscriptionCreateParameters struct {
	Properties *SubscriptionCreateParameterProperties `json:"properties,omitempty"`
}

type SubscriptionKeysContract 

type SubscriptionKeysContract struct {
	PrimaryKey   *string `json:"primaryKey,omitempty"`
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

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 added in v0.20230801.1071415 

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

type SubscriptionUpdateParameterProperties 

type SubscriptionUpdateParameterProperties struct {
	AllowTracing   *bool              `json:"allowTracing,omitempty"`
	DisplayName    *string            `json:"displayName,omitempty"`
	ExpirationDate *string            `json:"expirationDate,omitempty"`
	OwnerId        *string            `json:"ownerId,omitempty"`
	PrimaryKey     *string            `json:"primaryKey,omitempty"`
	Scope          *string            `json:"scope,omitempty"`
	SecondaryKey   *string            `json:"secondaryKey,omitempty"`
	State          *SubscriptionState `json:"state,omitempty"`
	StateComment   *string            `json:"stateComment,omitempty"`
}

func (*SubscriptionUpdateParameterProperties) GetExpirationDateAsTime 

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

func (*SubscriptionUpdateParameterProperties) SetExpirationDateAsTime 

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

type SubscriptionUpdateParameters 

type SubscriptionUpdateParameters struct {
	Properties *SubscriptionUpdateParameterProperties `json:"properties,omitempty"`
}

type Subscriptions2Id 

type Subscriptions2Id struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	SubscriptionName  string
}

Subscriptions2Id is a struct representing the Resource ID for a Subscriptions 2

func NewSubscriptions2ID 

func NewSubscriptions2ID(subscriptionId string, resourceGroupName string, serviceName string, subscriptionName string) Subscriptions2Id

NewSubscriptions2ID returns a new Subscriptions2Id struct

func ParseSubscriptions2ID 

func ParseSubscriptions2ID(input string) (*Subscriptions2Id, error)

ParseSubscriptions2ID parses 'input' into a Subscriptions2Id

func ParseSubscriptions2IDInsensitively 

func ParseSubscriptions2IDInsensitively(input string) (*Subscriptions2Id, error)

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

func (Subscriptions2Id) ID 

func (id Subscriptions2Id) ID() string

ID returns the formatted Subscriptions 2 ID

func (Subscriptions2Id) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Subscriptions 2 ID

func (Subscriptions2Id) String 

func (id Subscriptions2Id) String() string

String returns a human-readable description of this Subscriptions 2 ID

type UpdateOperationOptions 

type UpdateOperationOptions struct {
	AppType *AppType
	IfMatch *string
	Notify  *bool
}

func DefaultUpdateOperationOptions 

func DefaultUpdateOperationOptions() UpdateOperationOptions

func (UpdateOperationOptions) ToHeaders added in v0.20230801.1071415 

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

func (UpdateOperationOptions) ToOData added in v0.20230801.1071415 

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

func (UpdateOperationOptions) ToQuery added in v0.20230801.1071415 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SubscriptionContract
}

type UserSubscriptionGetOperationResponse 

type UserSubscriptionGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SubscriptionContract
}

type UserSubscriptions2Id added in v0.20230727.1090744 

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

UserSubscriptions2Id is a struct representing the Resource ID for a User Subscriptions 2

func NewUserSubscriptions2ID added in v0.20230727.1090744 

func NewUserSubscriptions2ID(subscriptionId string, resourceGroupName string, serviceName string, userId string, subscriptionName string) UserSubscriptions2Id

NewUserSubscriptions2ID returns a new UserSubscriptions2Id struct

func ParseUserSubscriptions2ID added in v0.20230727.1090744 

func ParseUserSubscriptions2ID(input string) (*UserSubscriptions2Id, error)

ParseUserSubscriptions2ID parses 'input' into a UserSubscriptions2Id

func ParseUserSubscriptions2IDInsensitively added in v0.20230727.1090744 

func ParseUserSubscriptions2IDInsensitively(input string) (*UserSubscriptions2Id, error)

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

func (UserSubscriptions2Id) ID added in v0.20230727.1090744 

func (id UserSubscriptions2Id) ID() string

ID returns the formatted User Subscriptions 2 ID

func (UserSubscriptions2Id) Segments added in v0.20230727.1090744 

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

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

func (UserSubscriptions2Id) String added in v0.20230727.1090744 

func (id UserSubscriptions2Id) String() string

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