tenantconfiguration

README

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

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

Client Initialization

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

Example Usage: TenantConfigurationClient.Create

ctx := context.TODO()

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


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

Example Usage: TenantConfigurationClient.Delete

ctx := context.TODO()


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

Example Usage: TenantConfigurationClient.Get

ctx := context.TODO()


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

Example Usage: TenantConfigurationClient.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

• type Configuration
• type ConfigurationOperationPredicate
  • func (p ConfigurationOperationPredicate) Matches(input Configuration) bool
• type ConfigurationProperties
• type CreateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse
• type TenantConfigurationClient
  • func NewTenantConfigurationClientWithBaseURI(sdkApi sdkEnv.Api) (*TenantConfigurationClient, error)
  • func (c TenantConfigurationClient) Create(ctx context.Context, input Configuration) (result CreateOperationResponse, err error)
  • func (c TenantConfigurationClient) Delete(ctx context.Context) (result DeleteOperationResponse, err error)
  • func (c TenantConfigurationClient) Get(ctx context.Context) (result GetOperationResponse, err error)
  • func (c TenantConfigurationClient) List(ctx context.Context) (result ListOperationResponse, err error)
  • func (c TenantConfigurationClient) ListComplete(ctx context.Context) (ListCompleteResult, error)
  • func (c TenantConfigurationClient) ListCompleteMatchingPredicate(ctx context.Context, predicate ConfigurationOperationPredicate) (result ListCompleteResult, err error)

Types

type Configuration

type Configuration struct {
	Id         *string                  `json:"id,omitempty"`
	Name       *string                  `json:"name,omitempty"`
	Properties *ConfigurationProperties `json:"properties,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"`
}

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 ListOperationResponse

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

type TenantConfigurationClient

type TenantConfigurationClient struct {
	Client *resourcemanager.Client
}

func NewTenantConfigurationClientWithBaseURI

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

func (TenantConfigurationClient) Create

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

Create ...

func (TenantConfigurationClient) Delete

func (c TenantConfigurationClient) Delete(ctx context.Context) (result DeleteOperationResponse, err error)

Delete ...

func (TenantConfigurationClient) Get

func (c TenantConfigurationClient) Get(ctx context.Context) (result GetOperationResponse, err error)

Get ...

func (TenantConfigurationClient) List

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

List ...

func (TenantConfigurationClient) ListComplete

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

ListComplete retrieves all the results into a single object

func (TenantConfigurationClient) ListCompleteMatchingPredicate

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate