workspacesettings

README

github.com/hashicorp/go-azure-sdk/resource-manager/security/2017-08-01-preview/workspacesettings Documentation

The workspacesettings SDK allows for interaction with the Azure Resource Manager Service security (API Version 2017-08-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/security/2017-08-01-preview/workspacesettings"

Client Initialization

client := workspacesettings.NewWorkspaceSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkspaceSettingsClient.Create

ctx := context.TODO()
id := workspacesettings.NewWorkspaceSettingID("12345678-1234-9876-4563-123456789012", "workspaceSettingValue")

payload := workspacesettings.WorkspaceSetting{
	// ...
}


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: WorkspaceSettingsClient.Delete

ctx := context.TODO()
id := workspacesettings.NewWorkspaceSettingID("12345678-1234-9876-4563-123456789012", "workspaceSettingValue")

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: WorkspaceSettingsClient.Get

ctx := context.TODO()
id := workspacesettings.NewWorkspaceSettingID("12345678-1234-9876-4563-123456789012", "workspaceSettingValue")

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

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: WorkspaceSettingsClient.Update

ctx := context.TODO()
id := workspacesettings.NewWorkspaceSettingID("12345678-1234-9876-4563-123456789012", "workspaceSettingValue")

payload := workspacesettings.WorkspaceSetting{
	// ...
}


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

Documentation

Index

• func ValidateWorkspaceSettingID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse
• type UpdateOperationResponse
• type WorkspaceSetting
• type WorkspaceSettingId
  • func NewWorkspaceSettingID(subscriptionId string, workspaceSettingName string) WorkspaceSettingId
  • func ParseWorkspaceSettingID(input string) (*WorkspaceSettingId, error)
  • func ParseWorkspaceSettingIDInsensitively(input string) (*WorkspaceSettingId, error)
  • func (id *WorkspaceSettingId) FromParseResult(input resourceids.ParseResult) error
  • func (id WorkspaceSettingId) ID() string
  • func (id WorkspaceSettingId) Segments() []resourceids.Segment
  • func (id WorkspaceSettingId) String() string
• type WorkspaceSettingOperationPredicate
  • func (p WorkspaceSettingOperationPredicate) Matches(input WorkspaceSetting) bool
• type WorkspaceSettingProperties
• type WorkspaceSettingsClient
  • func NewWorkspaceSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkspaceSettingsClient, error)
  • func (c WorkspaceSettingsClient) Create(ctx context.Context, id WorkspaceSettingId, input WorkspaceSetting) (result CreateOperationResponse, err error)
  • func (c WorkspaceSettingsClient) Delete(ctx context.Context, id WorkspaceSettingId) (result DeleteOperationResponse, err error)
  • func (c WorkspaceSettingsClient) Get(ctx context.Context, id WorkspaceSettingId) (result GetOperationResponse, err error)
  • func (c WorkspaceSettingsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
  • func (c WorkspaceSettingsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
  • func (c WorkspaceSettingsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListCompleteResult, err error)
  • func (c WorkspaceSettingsClient) Update(ctx context.Context, id WorkspaceSettingId, input WorkspaceSetting) (result UpdateOperationResponse, err error)

Functions

func ValidateWorkspaceSettingID

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

ValidateWorkspaceSettingID checks that 'input' can be parsed as a Workspace Setting ID

Types

type CreateOperationResponse

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

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationResponse

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

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkspaceSetting
}

type WorkspaceSetting

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

type WorkspaceSettingId

type WorkspaceSettingId struct {
	SubscriptionId       string
	WorkspaceSettingName string
}

WorkspaceSettingId is a struct representing the Resource ID for a Workspace Setting

func NewWorkspaceSettingID

func NewWorkspaceSettingID(subscriptionId string, workspaceSettingName string) WorkspaceSettingId

NewWorkspaceSettingID returns a new WorkspaceSettingId struct

func ParseWorkspaceSettingID

func ParseWorkspaceSettingID(input string) (*WorkspaceSettingId, error)

ParseWorkspaceSettingID parses 'input' into a WorkspaceSettingId

func ParseWorkspaceSettingIDInsensitively

func ParseWorkspaceSettingIDInsensitively(input string) (*WorkspaceSettingId, error)

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

func (*WorkspaceSettingId) FromParseResult

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

func (WorkspaceSettingId) ID

func (id WorkspaceSettingId) ID() string

ID returns the formatted Workspace Setting ID

func (WorkspaceSettingId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Workspace Setting ID

func (WorkspaceSettingId) String

func (id WorkspaceSettingId) String() string

String returns a human-readable description of this Workspace Setting ID

type WorkspaceSettingOperationPredicate

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

func (WorkspaceSettingOperationPredicate) Matches

func (p WorkspaceSettingOperationPredicate) Matches(input WorkspaceSetting) bool

type WorkspaceSettingProperties

type WorkspaceSettingProperties struct {
	Scope       string `json:"scope"`
	WorkspaceId string `json:"workspaceId"`
}

type WorkspaceSettingsClient

type WorkspaceSettingsClient struct {
	Client *resourcemanager.Client
}

func NewWorkspaceSettingsClientWithBaseURI

func NewWorkspaceSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkspaceSettingsClient, error)

func (WorkspaceSettingsClient) Create

func (c WorkspaceSettingsClient) Create(ctx context.Context, id WorkspaceSettingId, input WorkspaceSetting) (result CreateOperationResponse, err error)

Create ...

func (WorkspaceSettingsClient) Delete

func (c WorkspaceSettingsClient) Delete(ctx context.Context, id WorkspaceSettingId) (result DeleteOperationResponse, err error)

Delete ...

func (WorkspaceSettingsClient) Get

func (c WorkspaceSettingsClient) Get(ctx context.Context, id WorkspaceSettingId) (result GetOperationResponse, err error)

Get ...

func (WorkspaceSettingsClient) List

func (c WorkspaceSettingsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (WorkspaceSettingsClient) ListComplete

func (c WorkspaceSettingsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (WorkspaceSettingsClient) ListCompleteMatchingPredicate

func (c WorkspaceSettingsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate WorkspaceSettingOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (WorkspaceSettingsClient) Update

func (c WorkspaceSettingsClient) Update(ctx context.Context, id WorkspaceSettingId, input WorkspaceSetting) (result UpdateOperationResponse, err error)

Update ...