README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/signupsettings
Documentation
The signupsettings
SDK allows for interaction with Azure Resource Manager 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/signupsettings"
Client Initialization
client := signupsettings.NewSignUpSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: SignUpSettingsClient.CreateOrUpdate
ctx := context.TODO()
id := signupsettings.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName")
payload := signupsettings.PortalSignupSettings{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload, signupsettings.DefaultCreateOrUpdateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: SignUpSettingsClient.Get
ctx := context.TODO()
id := signupsettings.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName")
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: SignUpSettingsClient.GetEntityTag
ctx := context.TODO()
id := signupsettings.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName")
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: SignUpSettingsClient.Update
ctx := context.TODO()
id := signupsettings.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName")
payload := signupsettings.PortalSignupSettings{
// ...
}
read, err := client.Update(ctx, id, payload, signupsettings.DefaultUpdateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationOptions
- type CreateOrUpdateOperationResponse
- type GetEntityTagOperationResponse
- type GetOperationResponse
- type PortalSignupSettings
- type PortalSignupSettingsProperties
- type ServiceId
- type SignUpSettingsClient
- func (c SignUpSettingsClient) CreateOrUpdate(ctx context.Context, id ServiceId, input PortalSignupSettings, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c SignUpSettingsClient) Get(ctx context.Context, id ServiceId) (result GetOperationResponse, err error)
- func (c SignUpSettingsClient) GetEntityTag(ctx context.Context, id ServiceId) (result GetEntityTagOperationResponse, err error)
- func (c SignUpSettingsClient) Update(ctx context.Context, id ServiceId, input PortalSignupSettings, ...) (result UpdateOperationResponse, err error)
- type TermsOfServiceProperties
- type UpdateOperationOptions
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateServiceID ¶
ValidateServiceID checks that 'input' can be parsed as a Service ID
Types ¶
type CreateOrUpdateOperationOptions ¶
type CreateOrUpdateOperationOptions struct {
IfMatch *string
}
func DefaultCreateOrUpdateOperationOptions ¶
func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions
func (CreateOrUpdateOperationOptions) ToHeaders ¶
func (o CreateOrUpdateOperationOptions) ToHeaders() *client.Headers
func (CreateOrUpdateOperationOptions) ToOData ¶
func (o CreateOrUpdateOperationOptions) ToOData() *odata.Query
func (CreateOrUpdateOperationOptions) ToQuery ¶
func (o CreateOrUpdateOperationOptions) ToQuery() *client.QueryParams
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PortalSignupSettings }
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PortalSignupSettings }
type PortalSignupSettings ¶
type PortalSignupSettings struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *PortalSignupSettingsProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type PortalSignupSettingsProperties ¶
type PortalSignupSettingsProperties struct { Enabled *bool `json:"enabled,omitempty"` TermsOfService *TermsOfServiceProperties `json:"termsOfService,omitempty"` }
type ServiceId ¶
ServiceId is a struct representing the Resource ID for a Service
func NewServiceID ¶
NewServiceID returns a new ServiceId struct
func ParseServiceID ¶
ParseServiceID parses 'input' into a ServiceId
func ParseServiceIDInsensitively ¶
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) FromParseResult ¶
func (id *ServiceId) FromParseResult(input resourceids.ParseResult) error
func (ServiceId) Segments ¶
func (id ServiceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Service ID
type SignUpSettingsClient ¶
type SignUpSettingsClient struct {
Client *resourcemanager.Client
}
func NewSignUpSettingsClientWithBaseURI ¶
func NewSignUpSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*SignUpSettingsClient, error)
func (SignUpSettingsClient) CreateOrUpdate ¶
func (c SignUpSettingsClient) CreateOrUpdate(ctx context.Context, id ServiceId, input PortalSignupSettings, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (SignUpSettingsClient) Get ¶
func (c SignUpSettingsClient) Get(ctx context.Context, id ServiceId) (result GetOperationResponse, err error)
Get ...
func (SignUpSettingsClient) GetEntityTag ¶
func (c SignUpSettingsClient) GetEntityTag(ctx context.Context, id ServiceId) (result GetEntityTagOperationResponse, err error)
GetEntityTag ...
func (SignUpSettingsClient) Update ¶
func (c SignUpSettingsClient) Update(ctx context.Context, id ServiceId, input PortalSignupSettings, options UpdateOperationOptions) (result UpdateOperationResponse, err error)
Update ...
type UpdateOperationOptions ¶
type UpdateOperationOptions struct {
IfMatch *string
}
func DefaultUpdateOperationOptions ¶
func DefaultUpdateOperationOptions() UpdateOperationOptions
func (UpdateOperationOptions) ToHeaders ¶
func (o UpdateOperationOptions) ToHeaders() *client.Headers
func (UpdateOperationOptions) ToOData ¶
func (o UpdateOperationOptions) ToOData() *odata.Query
func (UpdateOperationOptions) ToQuery ¶
func (o UpdateOperationOptions) ToQuery() *client.QueryParams