portalsettings

README

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

The portalsettings SDK allows for interaction with Azure Resource Manager 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/portalsettings"

Client Initialization

client := portalsettings.NewPortalSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PortalSettingsClient.ListByService

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

read, err := client.ListByService(ctx, id)
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 ListByServiceOperationResponse
• type PortalSettingsClient
  • func NewPortalSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*PortalSettingsClient, error)
  • func (c PortalSettingsClient) ListByService(ctx context.Context, id ServiceId) (result ListByServiceOperationResponse, err error)
• type PortalSettingsCollection
• type PortalSettingsContract
• type PortalSettingsContractProperties
• type RegistrationDelegationSettingsProperties
• type ServiceId
  • func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId
  • func ParseServiceID(input string) (*ServiceId, error)
  • func ParseServiceIDInsensitively(input string) (*ServiceId, error)
  • func (id *ServiceId) FromParseResult(input resourceids.ParseResult) error
  • func (id ServiceId) ID() string
  • func (id ServiceId) Segments() []resourceids.Segment
  • func (id ServiceId) String() string
• type SubscriptionsDelegationSettingsProperties
• type TermsOfServiceProperties

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 ListByServiceOperationResponse

type ListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PortalSettingsCollection
}

type PortalSettingsClient

type PortalSettingsClient struct {
	Client *resourcemanager.Client
}

func NewPortalSettingsClientWithBaseURI

func NewPortalSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*PortalSettingsClient, error)

func (PortalSettingsClient) ListByService

func (c PortalSettingsClient) ListByService(ctx context.Context, id ServiceId) (result ListByServiceOperationResponse, err error)

ListByService ...

type PortalSettingsCollection

type PortalSettingsCollection struct {
	Count *int64                    `json:"count,omitempty"`
	Value *[]PortalSettingsContract `json:"value,omitempty"`
}

type PortalSettingsContract

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

type PortalSettingsContractProperties

type PortalSettingsContractProperties struct {
	Enabled          *bool                                      `json:"enabled,omitempty"`
	Subscriptions    *SubscriptionsDelegationSettingsProperties `json:"subscriptions,omitempty"`
	TermsOfService   *TermsOfServiceProperties                  `json:"termsOfService,omitempty"`
	Url              *string                                    `json:"url,omitempty"`
	UserRegistration *RegistrationDelegationSettingsProperties  `json:"userRegistration,omitempty"`
	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) FromParseResult

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

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 TermsOfServiceProperties

type TermsOfServiceProperties struct {
	ConsentRequired *bool   `json:"consentRequired,omitempty"`
	Enabled         *bool   `json:"enabled,omitempty"`
	Text            *string `json:"text,omitempty"`
}