delegationsettings

package
v0.20230109.1102005 Latest Latest
Warning

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

Go to latest
Published: Jan 9, 2023 License: MPL-2.0 Imports: 7 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2021-08-01/delegationsettings Documentation

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

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateServiceID

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

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

Types

type CreateOrUpdateOperationOptions

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *PortalDelegationSettings
}

type DelegationSettingsClient

type DelegationSettingsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewDelegationSettingsClientWithBaseURI

func NewDelegationSettingsClientWithBaseURI(endpoint string) DelegationSettingsClient

func (DelegationSettingsClient) CreateOrUpdate

CreateOrUpdate ...

func (DelegationSettingsClient) Get

Get ...

func (DelegationSettingsClient) GetEntityTag

GetEntityTag ...

func (DelegationSettingsClient) ListSecrets

ListSecrets ...

func (DelegationSettingsClient) Update

Update ...

type GetEntityTagOperationResponse

type GetEntityTagOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *PortalDelegationSettings
}

type ListSecretsOperationResponse

type ListSecretsOperationResponse struct {
	HttpResponse *http.Response
	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

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 SubscriptionsDelegationSettingsProperties

type SubscriptionsDelegationSettingsProperties struct {
	Enabled *bool `json:"enabled,omitempty"`
}

type UpdateOperationOptions

type UpdateOperationOptions struct {
	IfMatch *string
}

func DefaultUpdateOperationOptions

func DefaultUpdateOperationOptions() UpdateOperationOptions

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL