tenantconfiguration

package
v0.20231011.1091146 Latest Latest
Warning

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

Go to latest
Published: Oct 11, 2023 License: MPL-2.0 Imports: 13 Imported by: 0

README

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

The tenantconfiguration 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/tenantconfiguration"

Client Initialization

client := tenantconfiguration.NewTenantConfigurationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TenantConfigurationClient.Deploy

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

payload := tenantconfiguration.DeployConfigurationParameters{
	// ...
}


if err := client.DeployThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: TenantConfigurationClient.Save

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

payload := tenantconfiguration.SaveConfigurationParameter{
	// ...
}


if err := client.SaveThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: TenantConfigurationClient.Validate

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

payload := tenantconfiguration.DeployConfigurationParameters{
	// ...
}


if err := client.ValidateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAsyncOperationStatus

func PossibleValuesForAsyncOperationStatus() []string

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 AsyncOperationStatus

type AsyncOperationStatus string
const (
	AsyncOperationStatusFailed     AsyncOperationStatus = "Failed"
	AsyncOperationStatusInProgress AsyncOperationStatus = "InProgress"
	AsyncOperationStatusStarted    AsyncOperationStatus = "Started"
	AsyncOperationStatusSucceeded  AsyncOperationStatus = "Succeeded"
)

func (*AsyncOperationStatus) UnmarshalJSON added in v0.20230801.1071415

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

type DeployConfigurationParameterProperties

type DeployConfigurationParameterProperties struct {
	Branch string `json:"branch"`
	Force  *bool  `json:"force,omitempty"`
}

type DeployConfigurationParameters

type DeployConfigurationParameters struct {
	Properties *DeployConfigurationParameterProperties `json:"properties,omitempty"`
}

type DeployOperationResponse

type DeployOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type ErrorFieldContract

type ErrorFieldContract struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
	Target  *string `json:"target,omitempty"`
}

type ErrorResponseBody

type ErrorResponseBody struct {
	Code    *string               `json:"code,omitempty"`
	Details *[]ErrorFieldContract `json:"details,omitempty"`
	Message *string               `json:"message,omitempty"`
}

type OperationResultContract

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

type OperationResultContractProperties

type OperationResultContractProperties struct {
	ActionLog  *[]OperationResultLogItemContract `json:"actionLog,omitempty"`
	Error      *ErrorResponseBody                `json:"error,omitempty"`
	Id         *string                           `json:"id,omitempty"`
	ResultInfo *string                           `json:"resultInfo,omitempty"`
	Started    *string                           `json:"started,omitempty"`
	Status     *AsyncOperationStatus             `json:"status,omitempty"`
	Updated    *string                           `json:"updated,omitempty"`
}

func (*OperationResultContractProperties) GetStartedAsTime

func (o *OperationResultContractProperties) GetStartedAsTime() (*time.Time, error)

func (*OperationResultContractProperties) GetUpdatedAsTime

func (o *OperationResultContractProperties) GetUpdatedAsTime() (*time.Time, error)

func (*OperationResultContractProperties) SetStartedAsTime

func (o *OperationResultContractProperties) SetStartedAsTime(input time.Time)

func (*OperationResultContractProperties) SetUpdatedAsTime

func (o *OperationResultContractProperties) SetUpdatedAsTime(input time.Time)

type OperationResultLogItemContract

type OperationResultLogItemContract struct {
	Action     *string `json:"action,omitempty"`
	ObjectKey  *string `json:"objectKey,omitempty"`
	ObjectType *string `json:"objectType,omitempty"`
}

type SaveConfigurationParameter

type SaveConfigurationParameter struct {
	Properties *SaveConfigurationParameterProperties `json:"properties,omitempty"`
}

type SaveConfigurationParameterProperties

type SaveConfigurationParameterProperties struct {
	Branch string `json:"branch"`
	Force  *bool  `json:"force,omitempty"`
}

type SaveOperationResponse

type SaveOperationResponse struct {
	Poller       pollers.Poller
	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 TenantConfigurationClient

type TenantConfigurationClient struct {
	Client *resourcemanager.Client
}

func NewTenantConfigurationClientWithBaseURI

func NewTenantConfigurationClientWithBaseURI(sdkApi sdkEnv.Api) (*TenantConfigurationClient, error)

func (TenantConfigurationClient) Deploy

Deploy ...

func (TenantConfigurationClient) DeployThenPoll

DeployThenPoll performs Deploy then polls until it's completed

func (TenantConfigurationClient) Save

Save ...

func (TenantConfigurationClient) SaveThenPoll

SaveThenPoll performs Save then polls until it's completed

func (TenantConfigurationClient) Validate

Validate ...

func (TenantConfigurationClient) ValidateThenPoll

ValidateThenPoll performs Validate then polls until it's completed

type ValidateOperationResponse

type ValidateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

Jump to

Keyboard shortcuts

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