securitycontacts

package
v0.20230823.1052657 Latest Latest
Warning

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

 Go to latest Published: Aug 23, 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.SecurityContactsCreate

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

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


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

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

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

Example Usage: SecurityContactsClient.SecurityContactsGet

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

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

Example Usage: SecurityContactsClient.SecurityContactsList

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

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

Example Usage: SecurityContactsClient.SecurityContactsUpdate

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

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


read, err := client.SecurityContactsUpdate(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 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) SecurityContactsCreate 

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

SecurityContactsCreate ...

func (SecurityContactsClient) SecurityContactsDelete 

func (c SecurityContactsClient) SecurityContactsDelete(ctx context.Context, id SecurityContactId) (result SecurityContactsDeleteOperationResponse, err error)

SecurityContactsDelete ...

func (SecurityContactsClient) SecurityContactsGet 

func (c SecurityContactsClient) SecurityContactsGet(ctx context.Context, id SecurityContactId) (result SecurityContactsGetOperationResponse, err error)

SecurityContactsGet ...

func (SecurityContactsClient) SecurityContactsList 

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

SecurityContactsList ...

func (SecurityContactsClient) SecurityContactsListComplete 

func (c SecurityContactsClient) SecurityContactsListComplete(ctx context.Context, id commonids.SubscriptionId) (SecurityContactsListCompleteResult, error)

SecurityContactsListComplete retrieves all of the results into a single object

func (SecurityContactsClient) SecurityContactsListCompleteMatchingPredicate 

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

SecurityContactsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (SecurityContactsClient) SecurityContactsUpdate 

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

SecurityContactsUpdate ...

type SecurityContactsCreateOperationResponse 

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

type SecurityContactsDeleteOperationResponse 

type SecurityContactsDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type SecurityContactsGetOperationResponse 

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

type SecurityContactsListCompleteResult 

type SecurityContactsListCompleteResult struct {
	Items []SecurityContact
}

type SecurityContactsListOperationResponse 

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

func (SecurityContactsListOperationResponse) HasMore 

func (r SecurityContactsListOperationResponse) HasMore() bool

func (SecurityContactsListOperationResponse) LoadMore 

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

type SecurityContactsUpdateOperationResponse 

type SecurityContactsUpdateOperationResponse 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.