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-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.WorkspaceSettingsCreate

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

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


read, err := client.WorkspaceSettingsCreate(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.WorkspaceSettingsDelete

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

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

Example Usage: WorkspaceSettingsClient.WorkspaceSettingsGet

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

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

Example Usage: WorkspaceSettingsClient.WorkspaceSettingsList

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

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

Example Usage: WorkspaceSettingsClient.WorkspaceSettingsUpdate

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

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


read, err := client.WorkspaceSettingsUpdate(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 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) 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(endpoint string) WorkspaceSettingsClient
  • func (c WorkspaceSettingsClient) WorkspaceSettingsCreate(ctx context.Context, id WorkspaceSettingId, input WorkspaceSetting) (result WorkspaceSettingsCreateOperationResponse, err error)
  • func (c WorkspaceSettingsClient) WorkspaceSettingsDelete(ctx context.Context, id WorkspaceSettingId) (result WorkspaceSettingsDeleteOperationResponse, err error)
  • func (c WorkspaceSettingsClient) WorkspaceSettingsGet(ctx context.Context, id WorkspaceSettingId) (result WorkspaceSettingsGetOperationResponse, err error)
  • func (c WorkspaceSettingsClient) WorkspaceSettingsList(ctx context.Context, id commonids.SubscriptionId) (resp WorkspaceSettingsListOperationResponse, err error)
  • func (c WorkspaceSettingsClient) WorkspaceSettingsListComplete(ctx context.Context, id commonids.SubscriptionId) (WorkspaceSettingsListCompleteResult, error)
  • func (c WorkspaceSettingsClient) WorkspaceSettingsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (resp WorkspaceSettingsListCompleteResult, err error)
  • func (c WorkspaceSettingsClient) WorkspaceSettingsUpdate(ctx context.Context, id WorkspaceSettingId, input WorkspaceSetting) (result WorkspaceSettingsUpdateOperationResponse, err error)
• type WorkspaceSettingsCreateOperationResponse
• type WorkspaceSettingsDeleteOperationResponse
• type WorkspaceSettingsGetOperationResponse
• type WorkspaceSettingsListCompleteResult
• type WorkspaceSettingsListOperationResponse
  • func (r WorkspaceSettingsListOperationResponse) HasMore() bool
  • func (r WorkspaceSettingsListOperationResponse) LoadMore(ctx context.Context) (resp WorkspaceSettingsListOperationResponse, err error)
• type WorkspaceSettingsUpdateOperationResponse

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 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) 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 autorest.Client
	// contains filtered or unexported fields
}

func NewWorkspaceSettingsClientWithBaseURI

func NewWorkspaceSettingsClientWithBaseURI(endpoint string) WorkspaceSettingsClient

func (WorkspaceSettingsClient) WorkspaceSettingsCreate

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

WorkspaceSettingsCreate ...

func (WorkspaceSettingsClient) WorkspaceSettingsDelete

func (c WorkspaceSettingsClient) WorkspaceSettingsDelete(ctx context.Context, id WorkspaceSettingId) (result WorkspaceSettingsDeleteOperationResponse, err error)

WorkspaceSettingsDelete ...

func (WorkspaceSettingsClient) WorkspaceSettingsGet

func (c WorkspaceSettingsClient) WorkspaceSettingsGet(ctx context.Context, id WorkspaceSettingId) (result WorkspaceSettingsGetOperationResponse, err error)

WorkspaceSettingsGet ...

func (WorkspaceSettingsClient) WorkspaceSettingsList

func (c WorkspaceSettingsClient) WorkspaceSettingsList(ctx context.Context, id commonids.SubscriptionId) (resp WorkspaceSettingsListOperationResponse, err error)

WorkspaceSettingsList ...

func (WorkspaceSettingsClient) WorkspaceSettingsListComplete

func (c WorkspaceSettingsClient) WorkspaceSettingsListComplete(ctx context.Context, id commonids.SubscriptionId) (WorkspaceSettingsListCompleteResult, error)

WorkspaceSettingsListComplete retrieves all of the results into a single object

func (WorkspaceSettingsClient) WorkspaceSettingsListCompleteMatchingPredicate

func (c WorkspaceSettingsClient) WorkspaceSettingsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate WorkspaceSettingOperationPredicate) (resp WorkspaceSettingsListCompleteResult, err error)

WorkspaceSettingsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (WorkspaceSettingsClient) WorkspaceSettingsUpdate

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

WorkspaceSettingsUpdate ...

type WorkspaceSettingsCreateOperationResponse

type WorkspaceSettingsCreateOperationResponse struct {
	HttpResponse *http.Response
	Model        *WorkspaceSetting
}

type WorkspaceSettingsDeleteOperationResponse

type WorkspaceSettingsDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type WorkspaceSettingsGetOperationResponse

type WorkspaceSettingsGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *WorkspaceSetting
}

type WorkspaceSettingsListCompleteResult

type WorkspaceSettingsListCompleteResult struct {
	Items []WorkspaceSetting
}

type WorkspaceSettingsListOperationResponse

type WorkspaceSettingsListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]WorkspaceSetting
	// contains filtered or unexported fields
}

func (WorkspaceSettingsListOperationResponse) HasMore

func (r WorkspaceSettingsListOperationResponse) HasMore() bool

func (WorkspaceSettingsListOperationResponse) LoadMore

func (r WorkspaceSettingsListOperationResponse) LoadMore(ctx context.Context) (resp WorkspaceSettingsListOperationResponse, err error)

type WorkspaceSettingsUpdateOperationResponse

type WorkspaceSettingsUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *WorkspaceSetting
}