tenantconfigurationsyncstate

README

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

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

Client Initialization

client := tenantconfigurationsyncstate.NewTenantConfigurationSyncStateClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TenantConfigurationSyncStateClient.TenantConfigurationGetSyncState

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

read, err := client.TenantConfigurationGetSyncState(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 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 TenantConfigurationGetSyncStateOperationResponse
• type TenantConfigurationSyncStateClient
  • func NewTenantConfigurationSyncStateClientWithBaseURI(sdkApi sdkEnv.Api) (*TenantConfigurationSyncStateClient, error)
  • func (c TenantConfigurationSyncStateClient) TenantConfigurationGetSyncState(ctx context.Context, id ServiceId) (result TenantConfigurationGetSyncStateOperationResponse, err error)
• type TenantConfigurationSyncStateContract
• type TenantConfigurationSyncStateContractProperties
  • func (o *TenantConfigurationSyncStateContractProperties) GetConfigurationChangeDateAsTime() (*time.Time, error)
  • func (o *TenantConfigurationSyncStateContractProperties) GetSyncDateAsTime() (*time.Time, error)
  • func (o *TenantConfigurationSyncStateContractProperties) SetConfigurationChangeDateAsTime(input time.Time)
  • func (o *TenantConfigurationSyncStateContractProperties) SetSyncDateAsTime(input time.Time)

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 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 TenantConfigurationGetSyncStateOperationResponse

type TenantConfigurationGetSyncStateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TenantConfigurationSyncStateContract
}

type TenantConfigurationSyncStateClient

type TenantConfigurationSyncStateClient struct {
	Client *resourcemanager.Client
}

func NewTenantConfigurationSyncStateClientWithBaseURI

func NewTenantConfigurationSyncStateClientWithBaseURI(sdkApi sdkEnv.Api) (*TenantConfigurationSyncStateClient, error)

func (TenantConfigurationSyncStateClient) TenantConfigurationGetSyncState

func (c TenantConfigurationSyncStateClient) TenantConfigurationGetSyncState(ctx context.Context, id ServiceId) (result TenantConfigurationGetSyncStateOperationResponse, err error)

TenantConfigurationGetSyncState ...

type TenantConfigurationSyncStateContract

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

type TenantConfigurationSyncStateContractProperties

type TenantConfigurationSyncStateContractProperties struct {
	Branch                  *string `json:"branch,omitempty"`
	CommitId                *string `json:"commitId,omitempty"`
	ConfigurationChangeDate *string `json:"configurationChangeDate,omitempty"`
	IsExport                *bool   `json:"isExport,omitempty"`
	IsGitEnabled            *bool   `json:"isGitEnabled,omitempty"`
	IsSynced                *bool   `json:"isSynced,omitempty"`
	LastOperationId         *string `json:"lastOperationId,omitempty"`
	SyncDate                *string `json:"syncDate,omitempty"`
}

func (*TenantConfigurationSyncStateContractProperties) GetConfigurationChangeDateAsTime

func (o *TenantConfigurationSyncStateContractProperties) GetConfigurationChangeDateAsTime() (*time.Time, error)

func (*TenantConfigurationSyncStateContractProperties) GetSyncDateAsTime

func (o *TenantConfigurationSyncStateContractProperties) GetSyncDateAsTime() (*time.Time, error)

func (*TenantConfigurationSyncStateContractProperties) SetConfigurationChangeDateAsTime

func (o *TenantConfigurationSyncStateContractProperties) SetConfigurationChangeDateAsTime(input time.Time)

func (*TenantConfigurationSyncStateContractProperties) SetSyncDateAsTime

func (o *TenantConfigurationSyncStateContractProperties) SetSyncDateAsTime(input time.Time)