workspacesettings

package
v0.20231214.1160726 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 14, 2023 License: MPL-2.0 Imports: 9 Imported by: 0

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.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 := workspacesettings.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

Constants

This section is empty.

Variables

This section is empty.

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 added in v0.20230906.1160501 

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

type DeleteOperationResponse added in v0.20230906.1160501 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationResponse added in v0.20230906.1160501 

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

type ListCompleteResult added in v0.20230906.1160501 

type ListCompleteResult struct {
	Items []WorkspaceSetting
}

type ListOperationResponse added in v0.20230906.1160501 

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

func (ListOperationResponse) HasMore added in v0.20230906.1160501 

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore added in v0.20230906.1160501 

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

type UpdateOperationResponse added in v0.20230906.1160501 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	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 added in v0.20231127.1171502 

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

func NewWorkspaceSettingsClientWithBaseURI 

func NewWorkspaceSettingsClientWithBaseURI(endpoint string) WorkspaceSettingsClient

func (WorkspaceSettingsClient) Create added in v0.20230906.1160501 

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

Create ...

func (WorkspaceSettingsClient) Delete added in v0.20230906.1160501 

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

Delete ...

func (WorkspaceSettingsClient) Get added in v0.20230906.1160501 

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

Get ...

func (WorkspaceSettingsClient) List added in v0.20230906.1160501 

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

List ...

func (WorkspaceSettingsClient) ListComplete added in v0.20230906.1160501 

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

ListComplete retrieves all of the results into a single object

func (WorkspaceSettingsClient) ListCompleteMatchingPredicate added in v0.20230906.1160501 

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

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (WorkspaceSettingsClient) Update added in v0.20230906.1160501 

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

Update ...

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.