securitycontacts

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-helpers/resourcemanager/commonids"
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 := 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: 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

• func PossibleValuesForAlertNotifications() []string
• func PossibleValuesForAlertsToAdmins() []string
• func ValidateSecurityContactID(input interface{}, key string) (warnings []string, errors []error)
• type AlertNotifications
• type AlertsToAdmins
• type CreateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse
  • func (r ListOperationResponse) HasMore() bool
  • func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)
• type SecurityContact
• type SecurityContactId
  • func NewSecurityContactID(subscriptionId string, securityContactName string) SecurityContactId
  • func ParseSecurityContactID(input string) (*SecurityContactId, error)
  • func ParseSecurityContactIDInsensitively(input string) (*SecurityContactId, error)
  • func (id *SecurityContactId) FromParseResult(input resourceids.ParseResult) error
  • func (id SecurityContactId) ID() string
  • func (id SecurityContactId) Segments() []resourceids.Segment
  • func (id SecurityContactId) String() string
• type SecurityContactOperationPredicate
  • func (p SecurityContactOperationPredicate) Matches(input SecurityContact) bool
• type SecurityContactProperties
• type SecurityContactsClient
  • func NewSecurityContactsClientWithBaseURI(endpoint string) SecurityContactsClient
  • func (c SecurityContactsClient) Create(ctx context.Context, id SecurityContactId, input SecurityContact) (result CreateOperationResponse, err error)
  • func (c SecurityContactsClient) Delete(ctx context.Context, id SecurityContactId) (result DeleteOperationResponse, err error)
  • func (c SecurityContactsClient) Get(ctx context.Context, id SecurityContactId) (result GetOperationResponse, err error)
  • func (c SecurityContactsClient) List(ctx context.Context, id commonids.SubscriptionId) (resp ListOperationResponse, err error)
  • func (c SecurityContactsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
  • func (c SecurityContactsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (resp ListCompleteResult, err error)
  • func (c SecurityContactsClient) Update(ctx context.Context, id SecurityContactId, input SecurityContact) (result UpdateOperationResponse, err error)
• type UpdateOperationResponse

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

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

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []SecurityContact
}

type ListOperationResponse

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

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

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) FromParseResult

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

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

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

Create ...

func (SecurityContactsClient) Delete

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

Delete ...

func (SecurityContactsClient) Get

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

Get ...

func (SecurityContactsClient) List

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

List ...

func (SecurityContactsClient) ListComplete

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

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

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

Update ...

type UpdateOperationResponse

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