onboardtod4api

README

github.com/hashicorp/go-azure-sdk/resource-manager/security/2023-11-15/onboardtod4api Documentation

The onboardtod4api SDK allows for interaction with the Azure Resource Manager Service security (API Version 2023-11-15).

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/2023-11-15/onboardtod4api"

Client Initialization

client := onboardtod4api.NewOnboardToD4APIClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OnboardToD4APIClient.APICollectionsOnboardAzureApiManagementApi

ctx := context.TODO()
id := onboardtod4api.NewApiCollectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue")

if err := client.APICollectionsOnboardAzureApiManagementApiThenPoll(ctx, id); err != nil {
	// handle the error
}

Documentation

Index

• func PossibleValuesForProvisioningState() []string
• func ValidateApiCollectionID(input interface{}, key string) (warnings []string, errors []error)
• type APICollectionsOnboardAzureApiManagementApiOperationResponse
• type ApiCollection
• type ApiCollectionId
  • func NewApiCollectionID(subscriptionId string, resourceGroupName string, serviceName string, ...) ApiCollectionId
  • func ParseApiCollectionID(input string) (*ApiCollectionId, error)
  • func ParseApiCollectionIDInsensitively(input string) (*ApiCollectionId, error)
  • func (id *ApiCollectionId) FromParseResult(input resourceids.ParseResult) error
  • func (id ApiCollectionId) ID() string
  • func (id ApiCollectionId) Segments() []resourceids.Segment
  • func (id ApiCollectionId) String() string
• type ApiCollectionProperties
• type OnboardToD4APIClient
  • func NewOnboardToD4APIClientWithBaseURI(sdkApi sdkEnv.Api) (*OnboardToD4APIClient, error)
  • func (c OnboardToD4APIClient) APICollectionsOnboardAzureApiManagementApi(ctx context.Context, id ApiCollectionId) (result APICollectionsOnboardAzureApiManagementApiOperationResponse, err error)
  • func (c OnboardToD4APIClient) APICollectionsOnboardAzureApiManagementApiThenPoll(ctx context.Context, id ApiCollectionId) error
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateApiCollectionID

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

ValidateApiCollectionID checks that 'input' can be parsed as a Api Collection ID

Types

type APICollectionsOnboardAzureApiManagementApiOperationResponse

type APICollectionsOnboardAzureApiManagementApiOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiCollection
}

type ApiCollection

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

type ApiCollectionId

type ApiCollectionId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ApiId             string
}

ApiCollectionId is a struct representing the Resource ID for a Api Collection

func NewApiCollectionID

func NewApiCollectionID(subscriptionId string, resourceGroupName string, serviceName string, apiId string) ApiCollectionId

NewApiCollectionID returns a new ApiCollectionId struct

func ParseApiCollectionID

func ParseApiCollectionID(input string) (*ApiCollectionId, error)

ParseApiCollectionID parses 'input' into a ApiCollectionId

func ParseApiCollectionIDInsensitively

func ParseApiCollectionIDInsensitively(input string) (*ApiCollectionId, error)

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

func (*ApiCollectionId) FromParseResult

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

func (ApiCollectionId) ID

func (id ApiCollectionId) ID() string

ID returns the formatted Api Collection ID

func (ApiCollectionId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Api Collection ID

func (ApiCollectionId) String

func (id ApiCollectionId) String() string

String returns a human-readable description of this Api Collection ID

type ApiCollectionProperties

type ApiCollectionProperties struct {
	BaseUrl                                      *string            `json:"baseUrl,omitempty"`
	DiscoveredVia                                *string            `json:"discoveredVia,omitempty"`
	DisplayName                                  *string            `json:"displayName,omitempty"`
	NumberOfApiEndpoints                         *int64             `json:"numberOfApiEndpoints,omitempty"`
	NumberOfApiEndpointsWithSensitiveDataExposed *int64             `json:"numberOfApiEndpointsWithSensitiveDataExposed,omitempty"`
	NumberOfExternalApiEndpoints                 *int64             `json:"numberOfExternalApiEndpoints,omitempty"`
	NumberOfInactiveApiEndpoints                 *int64             `json:"numberOfInactiveApiEndpoints,omitempty"`
	NumberOfUnauthenticatedApiEndpoints          *int64             `json:"numberOfUnauthenticatedApiEndpoints,omitempty"`
	ProvisioningState                            *ProvisioningState `json:"provisioningState,omitempty"`
	SensitivityLabel                             *string            `json:"sensitivityLabel,omitempty"`
}

type OnboardToD4APIClient

type OnboardToD4APIClient struct {
	Client *resourcemanager.Client
}

func NewOnboardToD4APIClientWithBaseURI

func NewOnboardToD4APIClientWithBaseURI(sdkApi sdkEnv.Api) (*OnboardToD4APIClient, error)

func (OnboardToD4APIClient) APICollectionsOnboardAzureApiManagementApi

func (c OnboardToD4APIClient) APICollectionsOnboardAzureApiManagementApi(ctx context.Context, id ApiCollectionId) (result APICollectionsOnboardAzureApiManagementApiOperationResponse, err error)

APICollectionsOnboardAzureApiManagementApi ...

func (OnboardToD4APIClient) APICollectionsOnboardAzureApiManagementApiThenPoll

func (c OnboardToD4APIClient) APICollectionsOnboardAzureApiManagementApiThenPoll(ctx context.Context, id ApiCollectionId) error

APICollectionsOnboardAzureApiManagementApiThenPoll performs APICollectionsOnboardAzureApiManagementApi then polls until it's completed

type ProvisioningState

type ProvisioningState string

const (
	ProvisioningStateCanceled   ProvisioningState = "Canceled"
	ProvisioningStateFailed     ProvisioningState = "Failed"
	ProvisioningStateInProgress ProvisioningState = "InProgress"
	ProvisioningStateSucceeded  ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error