tenantconfigurations

README

github.com/hashicorp/go-azure-sdk/resource-manager/portal/2020-09-01-preview/tenantconfigurations Documentation

The tenantconfigurations SDK allows for interaction with the Azure Resource Manager Service portal (API Version 2020-09-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/portal/2020-09-01-preview/tenantconfigurations"

Client Initialization

client := tenantconfigurations.NewTenantConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TenantConfigurationsClient.Create

ctx := context.TODO()
id := tenantconfigurations.NewTenantConfigurationID("tenantConfigurationValue")

payload := tenantconfigurations.Configuration{
	// ...
}


read, err := client.Create(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: TenantConfigurationsClient.Delete

ctx := context.TODO()
id := tenantconfigurations.NewTenantConfigurationID("tenantConfigurationValue")

read, err := client.Delete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: TenantConfigurationsClient.Get

ctx := context.TODO()
id := tenantconfigurations.NewTenantConfigurationID("tenantConfigurationValue")

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: TenantConfigurationsClient.List

ctx := context.TODO()


// alternatively `client.List(ctx)` can be used to do batched pagination
items, err := client.ListComplete(ctx)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func PossibleValuesForResourceProvisioningState() []string
• func ValidateTenantConfigurationID(input interface{}, key string) (warnings []string, errors []error)
• type Configuration
• type ConfigurationOperationPredicate
  • func (p ConfigurationOperationPredicate) Matches(input Configuration) bool
• type ConfigurationProperties
• type CreateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type ListCompleteResult
• type ListCustomPager
  • func (p *ListCustomPager) NextPageLink() *odata.Link
• type ListOperationResponse
• type ResourceProvisioningState
  • func (s *ResourceProvisioningState) UnmarshalJSON(bytes []byte) error
• type TenantConfigurationId
  • func NewTenantConfigurationID(tenantConfigurationName string) TenantConfigurationId
  • func ParseTenantConfigurationID(input string) (*TenantConfigurationId, error)
  • func ParseTenantConfigurationIDInsensitively(input string) (*TenantConfigurationId, error)
  • func (id *TenantConfigurationId) FromParseResult(input resourceids.ParseResult) error
  • func (id TenantConfigurationId) ID() string
  • func (id TenantConfigurationId) Segments() []resourceids.Segment
  • func (id TenantConfigurationId) String() string
• type TenantConfigurationsClient
  • func NewTenantConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*TenantConfigurationsClient, error)
  • func (c TenantConfigurationsClient) Create(ctx context.Context, id TenantConfigurationId, input Configuration) (result CreateOperationResponse, err error)
  • func (c TenantConfigurationsClient) Delete(ctx context.Context, id TenantConfigurationId) (result DeleteOperationResponse, err error)
  • func (c TenantConfigurationsClient) Get(ctx context.Context, id TenantConfigurationId) (result GetOperationResponse, err error)
  • func (c TenantConfigurationsClient) List(ctx context.Context) (result ListOperationResponse, err error)
  • func (c TenantConfigurationsClient) ListComplete(ctx context.Context) (ListCompleteResult, error)
  • func (c TenantConfigurationsClient) ListCompleteMatchingPredicate(ctx context.Context, predicate ConfigurationOperationPredicate) (result ListCompleteResult, err error)

Functions

func PossibleValuesForResourceProvisioningState

func PossibleValuesForResourceProvisioningState() []string

func ValidateTenantConfigurationID

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

ValidateTenantConfigurationID checks that 'input' can be parsed as a Tenant Configuration ID

Types

type Configuration

type Configuration struct {
	Id         *string                  `json:"id,omitempty"`
	Name       *string                  `json:"name,omitempty"`
	Properties *ConfigurationProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData   `json:"systemData,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type ConfigurationOperationPredicate

type ConfigurationOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (ConfigurationOperationPredicate) Matches

func (p ConfigurationOperationPredicate) Matches(input Configuration) bool

type ConfigurationProperties

type ConfigurationProperties struct {
	EnforcePrivateMarkdownStorage *bool                      `json:"enforcePrivateMarkdownStorage,omitempty"`
	ProvisioningState             *ResourceProvisioningState `json:"provisioningState,omitempty"`
}

type CreateOperationResponse

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Configuration
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Configuration
}

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Configuration
}

type ListCustomPager

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListCustomPager) NextPageLink

func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Configuration
}

type ResourceProvisioningState

type ResourceProvisioningState string

const (
	ResourceProvisioningStateCanceled  ResourceProvisioningState = "Canceled"
	ResourceProvisioningStateFailed    ResourceProvisioningState = "Failed"
	ResourceProvisioningStateSucceeded ResourceProvisioningState = "Succeeded"
)

func (*ResourceProvisioningState) UnmarshalJSON

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

type TenantConfigurationId

type TenantConfigurationId struct {
	TenantConfigurationName string
}

TenantConfigurationId is a struct representing the Resource ID for a Tenant Configuration

func NewTenantConfigurationID

func NewTenantConfigurationID(tenantConfigurationName string) TenantConfigurationId

NewTenantConfigurationID returns a new TenantConfigurationId struct

func ParseTenantConfigurationID

func ParseTenantConfigurationID(input string) (*TenantConfigurationId, error)

ParseTenantConfigurationID parses 'input' into a TenantConfigurationId

func ParseTenantConfigurationIDInsensitively

func ParseTenantConfigurationIDInsensitively(input string) (*TenantConfigurationId, error)

ParseTenantConfigurationIDInsensitively parses 'input' case-insensitively into a TenantConfigurationId note: this method should only be used for API response data and not user input

func (*TenantConfigurationId) FromParseResult

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

func (TenantConfigurationId) ID

func (id TenantConfigurationId) ID() string

ID returns the formatted Tenant Configuration ID

func (TenantConfigurationId) Segments

func (id TenantConfigurationId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Tenant Configuration ID

func (TenantConfigurationId) String

func (id TenantConfigurationId) String() string

String returns a human-readable description of this Tenant Configuration ID

type TenantConfigurationsClient

type TenantConfigurationsClient struct {
	Client *resourcemanager.Client
}

func NewTenantConfigurationsClientWithBaseURI

func NewTenantConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*TenantConfigurationsClient, error)

func (TenantConfigurationsClient) Create

func (c TenantConfigurationsClient) Create(ctx context.Context, id TenantConfigurationId, input Configuration) (result CreateOperationResponse, err error)

Create ...

func (TenantConfigurationsClient) Delete

func (c TenantConfigurationsClient) Delete(ctx context.Context, id TenantConfigurationId) (result DeleteOperationResponse, err error)

Delete ...

func (TenantConfigurationsClient) Get

func (c TenantConfigurationsClient) Get(ctx context.Context, id TenantConfigurationId) (result GetOperationResponse, err error)

Get ...

func (TenantConfigurationsClient) List

func (c TenantConfigurationsClient) List(ctx context.Context) (result ListOperationResponse, err error)

List ...

func (TenantConfigurationsClient) ListComplete

func (c TenantConfigurationsClient) ListComplete(ctx context.Context) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (TenantConfigurationsClient) ListCompleteMatchingPredicate

func (c TenantConfigurationsClient) ListCompleteMatchingPredicate(ctx context.Context, predicate ConfigurationOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate