README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2023-03-01-preview/delegationsettings
Documentation
The delegationsettings
SDK allows for interaction with the Azure Resource Manager Service apimanagement
(API Version 2023-03-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-03-01-preview/delegationsettings"
Client Initialization
client := delegationsettings.NewDelegationSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: DelegationSettingsClient.CreateOrUpdate
ctx := context.TODO()
id := delegationsettings.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
payload := delegationsettings.PortalDelegationSettings{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload, delegationsettings.DefaultCreateOrUpdateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: DelegationSettingsClient.Get
ctx := context.TODO()
id := delegationsettings.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
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: DelegationSettingsClient.GetEntityTag
ctx := context.TODO()
id := delegationsettings.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
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: DelegationSettingsClient.ListSecrets
ctx := context.TODO()
id := delegationsettings.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
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: DelegationSettingsClient.Update
ctx := context.TODO()
id := delegationsettings.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
payload := delegationsettings.PortalDelegationSettings{
// ...
}
read, err := client.Update(ctx, id, payload, delegationsettings.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 DelegationSettingsClient
- func (c DelegationSettingsClient) CreateOrUpdate(ctx context.Context, id ServiceId, input PortalDelegationSettings, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c DelegationSettingsClient) Get(ctx context.Context, id ServiceId) (result GetOperationResponse, err error)
- func (c DelegationSettingsClient) GetEntityTag(ctx context.Context, id ServiceId) (result GetEntityTagOperationResponse, err error)
- func (c DelegationSettingsClient) ListSecrets(ctx context.Context, id ServiceId) (result ListSecretsOperationResponse, err error)
- func (c DelegationSettingsClient) Update(ctx context.Context, id ServiceId, input PortalDelegationSettings, ...) (result UpdateOperationResponse, err error)
- type GetEntityTagOperationResponse
- type GetOperationResponse
- type ListSecretsOperationResponse
- type PortalDelegationSettings
- type PortalDelegationSettingsProperties
- type PortalSettingValidationKeyContract
- type RegistrationDelegationSettingsProperties
- type ServiceId
- type SubscriptionsDelegationSettingsProperties
- 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 *PortalDelegationSettings }
type DelegationSettingsClient ¶
type DelegationSettingsClient struct {
Client *resourcemanager.Client
}
func NewDelegationSettingsClientWithBaseURI ¶
func NewDelegationSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*DelegationSettingsClient, error)
func (DelegationSettingsClient) CreateOrUpdate ¶
func (c DelegationSettingsClient) CreateOrUpdate(ctx context.Context, id ServiceId, input PortalDelegationSettings, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (DelegationSettingsClient) Get ¶
func (c DelegationSettingsClient) Get(ctx context.Context, id ServiceId) (result GetOperationResponse, err error)
Get ...
func (DelegationSettingsClient) GetEntityTag ¶
func (c DelegationSettingsClient) GetEntityTag(ctx context.Context, id ServiceId) (result GetEntityTagOperationResponse, err error)
GetEntityTag ...
func (DelegationSettingsClient) ListSecrets ¶
func (c DelegationSettingsClient) ListSecrets(ctx context.Context, id ServiceId) (result ListSecretsOperationResponse, err error)
ListSecrets ...
func (DelegationSettingsClient) Update ¶
func (c DelegationSettingsClient) Update(ctx context.Context, id ServiceId, input PortalDelegationSettings, options UpdateOperationOptions) (result UpdateOperationResponse, err error)
Update ...
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PortalDelegationSettings }
type ListSecretsOperationResponse ¶
type ListSecretsOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PortalSettingValidationKeyContract }
type PortalDelegationSettings ¶
type PortalDelegationSettings struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *PortalDelegationSettingsProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type PortalDelegationSettingsProperties ¶
type PortalDelegationSettingsProperties struct { Subscriptions *SubscriptionsDelegationSettingsProperties `json:"subscriptions,omitempty"` Url *string `json:"url,omitempty"` UserRegistration *RegistrationDelegationSettingsProperties `json:"userRegistration,omitempty"` ValidationKey *string `json:"validationKey,omitempty"` }
type PortalSettingValidationKeyContract ¶
type PortalSettingValidationKeyContract struct {
ValidationKey *string `json:"validationKey,omitempty"`
}
type RegistrationDelegationSettingsProperties ¶
type RegistrationDelegationSettingsProperties struct {
Enabled *bool `json:"enabled,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) Segments ¶
func (id ServiceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Service ID
type SubscriptionsDelegationSettingsProperties ¶
type SubscriptionsDelegationSettingsProperties struct {
Enabled *bool `json:"enabled,omitempty"`
}
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
Source Files ¶
- client.go
- id_service.go
- method_createorupdate.go
- method_get.go
- method_getentitytag.go
- method_listsecrets.go
- method_update.go
- model_portaldelegationsettings.go
- model_portaldelegationsettingsproperties.go
- model_portalsettingvalidationkeycontract.go
- model_registrationdelegationsettingsproperties.go
- model_subscriptionsdelegationsettingsproperties.go
- version.go