subscriptiondiagnosticsettings

README

github.com/hashicorp/go-azure-sdk/resource-manager/insights/2021-05-01-preview/subscriptiondiagnosticsettings Documentation

The subscriptiondiagnosticsettings SDK allows for interaction with the Azure Resource Manager Service insights (API Version 2021-05-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/insights/2021-05-01-preview/subscriptiondiagnosticsettings"

Client Initialization

client := subscriptiondiagnosticsettings.NewSubscriptionDiagnosticSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SubscriptionDiagnosticSettingsClient.CreateOrUpdate

ctx := context.TODO()
id := subscriptiondiagnosticsettings.NewDiagnosticSettingID("12345678-1234-9876-4563-123456789012", "diagnosticSettingValue")

payload := subscriptiondiagnosticsettings.SubscriptionDiagnosticSettingsResource{
	// ...
}


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

Example Usage: SubscriptionDiagnosticSettingsClient.Delete

ctx := context.TODO()
id := subscriptiondiagnosticsettings.NewDiagnosticSettingID("12345678-1234-9876-4563-123456789012", "diagnosticSettingValue")

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

ctx := context.TODO()
id := subscriptiondiagnosticsettings.NewDiagnosticSettingID("12345678-1234-9876-4563-123456789012", "diagnosticSettingValue")

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

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

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

Documentation

Index

• func ValidateDiagnosticSettingID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type DiagnosticSettingId
  • func NewDiagnosticSettingID(subscriptionId string, diagnosticSettingName string) DiagnosticSettingId
  • func ParseDiagnosticSettingID(input string) (*DiagnosticSettingId, error)
  • func ParseDiagnosticSettingIDInsensitively(input string) (*DiagnosticSettingId, error)
  • func (id *DiagnosticSettingId) FromParseResult(input resourceids.ParseResult) error
  • func (id DiagnosticSettingId) ID() string
  • func (id DiagnosticSettingId) Segments() []resourceids.Segment
  • func (id DiagnosticSettingId) String() string
• type GetOperationResponse
• type ListOperationResponse
• type SubscriptionDiagnosticSettings
• type SubscriptionDiagnosticSettingsClient
  • func NewSubscriptionDiagnosticSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*SubscriptionDiagnosticSettingsClient, error)
  • func (c SubscriptionDiagnosticSettingsClient) CreateOrUpdate(ctx context.Context, id DiagnosticSettingId, ...) (result CreateOrUpdateOperationResponse, err error)
  • func (c SubscriptionDiagnosticSettingsClient) Delete(ctx context.Context, id DiagnosticSettingId) (result DeleteOperationResponse, err error)
  • func (c SubscriptionDiagnosticSettingsClient) Get(ctx context.Context, id DiagnosticSettingId) (result GetOperationResponse, err error)
  • func (c SubscriptionDiagnosticSettingsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
• type SubscriptionDiagnosticSettingsResource
• type SubscriptionDiagnosticSettingsResourceCollection
• type SubscriptionLogSettings

Functions

func ValidateDiagnosticSettingID

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

ValidateDiagnosticSettingID checks that 'input' can be parsed as a Diagnostic Setting ID

Types

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SubscriptionDiagnosticSettingsResource
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type DiagnosticSettingId

type DiagnosticSettingId struct {
	SubscriptionId        string
	DiagnosticSettingName string
}

DiagnosticSettingId is a struct representing the Resource ID for a Diagnostic Setting

func NewDiagnosticSettingID

func NewDiagnosticSettingID(subscriptionId string, diagnosticSettingName string) DiagnosticSettingId

NewDiagnosticSettingID returns a new DiagnosticSettingId struct

func ParseDiagnosticSettingID

func ParseDiagnosticSettingID(input string) (*DiagnosticSettingId, error)

ParseDiagnosticSettingID parses 'input' into a DiagnosticSettingId

func ParseDiagnosticSettingIDInsensitively

func ParseDiagnosticSettingIDInsensitively(input string) (*DiagnosticSettingId, error)

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

func (*DiagnosticSettingId) FromParseResult

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

func (DiagnosticSettingId) ID

func (id DiagnosticSettingId) ID() string

ID returns the formatted Diagnostic Setting ID

func (DiagnosticSettingId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Diagnostic Setting ID

func (DiagnosticSettingId) String

func (id DiagnosticSettingId) String() string

String returns a human-readable description of this Diagnostic Setting ID

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SubscriptionDiagnosticSettingsResource
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SubscriptionDiagnosticSettingsResourceCollection
}

type SubscriptionDiagnosticSettings

type SubscriptionDiagnosticSettings struct {
	EventHubAuthorizationRuleId *string                    `json:"eventHubAuthorizationRuleId,omitempty"`
	EventHubName                *string                    `json:"eventHubName,omitempty"`
	Logs                        *[]SubscriptionLogSettings `json:"logs,omitempty"`
	MarketplacePartnerId        *string                    `json:"marketplacePartnerId,omitempty"`
	ServiceBusRuleId            *string                    `json:"serviceBusRuleId,omitempty"`
	StorageAccountId            *string                    `json:"storageAccountId,omitempty"`
	WorkspaceId                 *string                    `json:"workspaceId,omitempty"`
}

type SubscriptionDiagnosticSettingsClient

type SubscriptionDiagnosticSettingsClient struct {
	Client *resourcemanager.Client
}

func NewSubscriptionDiagnosticSettingsClientWithBaseURI

func NewSubscriptionDiagnosticSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*SubscriptionDiagnosticSettingsClient, error)

func (SubscriptionDiagnosticSettingsClient) CreateOrUpdate

func (c SubscriptionDiagnosticSettingsClient) CreateOrUpdate(ctx context.Context, id DiagnosticSettingId, input SubscriptionDiagnosticSettingsResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SubscriptionDiagnosticSettingsClient) Delete

func (c SubscriptionDiagnosticSettingsClient) Delete(ctx context.Context, id DiagnosticSettingId) (result DeleteOperationResponse, err error)

Delete ...

func (SubscriptionDiagnosticSettingsClient) Get

func (c SubscriptionDiagnosticSettingsClient) Get(ctx context.Context, id DiagnosticSettingId) (result GetOperationResponse, err error)

Get ...

func (SubscriptionDiagnosticSettingsClient) List

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

List ...

type SubscriptionDiagnosticSettingsResource

type SubscriptionDiagnosticSettingsResource struct {
	Id         *string                         `json:"id,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Properties *SubscriptionDiagnosticSettings `json:"properties,omitempty"`
	SystemData *systemdata.SystemData          `json:"systemData,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type SubscriptionDiagnosticSettingsResourceCollection

type SubscriptionDiagnosticSettingsResourceCollection struct {
	Value *[]SubscriptionDiagnosticSettingsResource `json:"value,omitempty"`
}

type SubscriptionLogSettings

type SubscriptionLogSettings struct {
	Category      *string `json:"category,omitempty"`
	CategoryGroup *string `json:"categoryGroup,omitempty"`
	Enabled       bool    `json:"enabled"`
}