securitycontacts

package
v0.20231016.1155426 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := securitycontacts.NewSecurityContactsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SecurityContactsClient.Create

ctx := context.TODO()
id := securitycontacts.NewSecurityContactID("12345678-1234-9876-4563-123456789012", "securityContactValue")

payload := securitycontacts.SecurityContact{
	// ...
}


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

ctx := context.TODO()
id := securitycontacts.NewSecurityContactID("12345678-1234-9876-4563-123456789012", "securityContactValue")

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

ctx := context.TODO()
id := securitycontacts.NewSecurityContactID("12345678-1234-9876-4563-123456789012", "securityContactValue")

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

ctx := context.TODO()
id := securitycontacts.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: SecurityContactsClient.Update

ctx := context.TODO()
id := securitycontacts.NewSecurityContactID("12345678-1234-9876-4563-123456789012", "securityContactValue")

payload := securitycontacts.SecurityContact{
	// ...
}


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 PossibleValuesForAlertNotifications 

func PossibleValuesForAlertNotifications() []string

func PossibleValuesForAlertsToAdmins 

func PossibleValuesForAlertsToAdmins() []string

func ValidateSecurityContactID 

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

ValidateSecurityContactID checks that 'input' can be parsed as a Security Contact ID

Types

type AlertNotifications 

type AlertNotifications string
const (
	AlertNotificationsOff AlertNotifications = "Off"
	AlertNotificationsOn  AlertNotifications = "On"
)

type AlertsToAdmins 

type AlertsToAdmins string
const (
	AlertsToAdminsOff AlertsToAdmins = "Off"
	AlertsToAdminsOn  AlertsToAdmins = "On"
)

type CreateOperationResponse added in v0.20230906.1160501 

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

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        *SecurityContact
}

type ListCompleteResult added in v0.20230906.1160501 

type ListCompleteResult struct {
	Items []SecurityContact
}

type ListOperationResponse added in v0.20230906.1160501 

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]SecurityContact
	// 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 SecurityContact 

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

type SecurityContactId 

type SecurityContactId struct {
	SubscriptionId      string
	SecurityContactName string
}

SecurityContactId is a struct representing the Resource ID for a Security Contact

func NewSecurityContactID 

func NewSecurityContactID(subscriptionId string, securityContactName string) SecurityContactId

NewSecurityContactID returns a new SecurityContactId struct

func ParseSecurityContactID 

func ParseSecurityContactID(input string) (*SecurityContactId, error)

ParseSecurityContactID parses 'input' into a SecurityContactId

func ParseSecurityContactIDInsensitively 

func ParseSecurityContactIDInsensitively(input string) (*SecurityContactId, error)

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

func (SecurityContactId) ID 

func (id SecurityContactId) ID() string

ID returns the formatted Security Contact ID

func (SecurityContactId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Security Contact ID

func (SecurityContactId) String 

func (id SecurityContactId) String() string

String returns a human-readable description of this Security Contact ID

type SecurityContactOperationPredicate 

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

func (SecurityContactOperationPredicate) Matches 

func (p SecurityContactOperationPredicate) Matches(input SecurityContact) bool

type SecurityContactProperties 

type SecurityContactProperties struct {
	AlertNotifications AlertNotifications `json:"alertNotifications"`
	AlertsToAdmins     AlertsToAdmins     `json:"alertsToAdmins"`
	Email              string             `json:"email"`
	Phone              *string            `json:"phone,omitempty"`
}

type SecurityContactsClient 

type SecurityContactsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewSecurityContactsClientWithBaseURI 

func NewSecurityContactsClientWithBaseURI(endpoint string) SecurityContactsClient

func (SecurityContactsClient) Create added in v0.20230906.1160501 

func (c SecurityContactsClient) Create(ctx context.Context, id SecurityContactId, input SecurityContact) (result CreateOperationResponse, err error)

Create ...

func (SecurityContactsClient) Delete added in v0.20230906.1160501 

func (c SecurityContactsClient) Delete(ctx context.Context, id SecurityContactId) (result DeleteOperationResponse, err error)

Delete ...

func (SecurityContactsClient) Get added in v0.20230906.1160501 

func (c SecurityContactsClient) Get(ctx context.Context, id SecurityContactId) (result GetOperationResponse, err error)

Get ...

func (SecurityContactsClient) List added in v0.20230906.1160501 

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

List ...

func (SecurityContactsClient) ListComplete added in v0.20230906.1160501 

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

ListComplete retrieves all of the results into a single object

func (SecurityContactsClient) ListCompleteMatchingPredicate added in v0.20230906.1160501 

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

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (SecurityContactsClient) Update added in v0.20230906.1160501 

func (c SecurityContactsClient) Update(ctx context.Context, id SecurityContactId, input SecurityContact) (result UpdateOperationResponse, err error)

Update ...

type UpdateOperationResponse added in v0.20230906.1160501 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *SecurityContact
}

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.