apimconfig

package
v0.20231108.1164943 Latest Latest
Warning

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

Go to latest
Published: Nov 8, 2023 License: MPL-2.0 Imports: 9 Imported by: 1

README

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

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

Client Initialization

client := apimconfig.NewAPIMConfigClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: APIMConfigClient.APICollectionsGetByAzureApiManagementService

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

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

Example Usage: APIMConfigClient.APICollectionsListByAzureApiManagementService

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

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

Example Usage: APIMConfigClient.APICollectionsOffboardAzureApiManagementApi

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

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

Example Usage: APIMConfigClient.APICollectionsOnboardAzureApiManagementApi

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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

func ValidateServiceID

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

Types

type APICollectionsGetByAzureApiManagementServiceOperationResponse

type APICollectionsGetByAzureApiManagementServiceOperationResponse struct {
	HttpResponse *http.Response
	Model        *ApiCollection
}

type APICollectionsListByAzureApiManagementServiceCompleteResult

type APICollectionsListByAzureApiManagementServiceCompleteResult struct {
	Items []ApiCollection
}

type APICollectionsListByAzureApiManagementServiceOperationResponse

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

func (APICollectionsListByAzureApiManagementServiceOperationResponse) HasMore

func (APICollectionsListByAzureApiManagementServiceOperationResponse) LoadMore

type APICollectionsOffboardAzureApiManagementApiOperationResponse

type APICollectionsOffboardAzureApiManagementApiOperationResponse struct {
	HttpResponse *http.Response
}

type APICollectionsOnboardAzureApiManagementApiOperationResponse

type APICollectionsOnboardAzureApiManagementApiOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type APIMConfigClient

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

func NewAPIMConfigClientWithBaseURI

func NewAPIMConfigClientWithBaseURI(endpoint string) APIMConfigClient

func (APIMConfigClient) APICollectionsGetByAzureApiManagementService

func (c APIMConfigClient) APICollectionsGetByAzureApiManagementService(ctx context.Context, id ApiCollectionId) (result APICollectionsGetByAzureApiManagementServiceOperationResponse, err error)

APICollectionsGetByAzureApiManagementService ...

func (APIMConfigClient) APICollectionsListByAzureApiManagementService

func (c APIMConfigClient) APICollectionsListByAzureApiManagementService(ctx context.Context, id ServiceId) (resp APICollectionsListByAzureApiManagementServiceOperationResponse, err error)

APICollectionsListByAzureApiManagementService ...

func (APIMConfigClient) APICollectionsListByAzureApiManagementServiceComplete

func (c APIMConfigClient) APICollectionsListByAzureApiManagementServiceComplete(ctx context.Context, id ServiceId) (APICollectionsListByAzureApiManagementServiceCompleteResult, error)

APICollectionsListByAzureApiManagementServiceComplete retrieves all of the results into a single object

func (APIMConfigClient) APICollectionsListByAzureApiManagementServiceCompleteMatchingPredicate

func (c APIMConfigClient) APICollectionsListByAzureApiManagementServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, predicate ApiCollectionOperationPredicate) (resp APICollectionsListByAzureApiManagementServiceCompleteResult, err error)

APICollectionsListByAzureApiManagementServiceCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (APIMConfigClient) APICollectionsOffboardAzureApiManagementApi

func (c APIMConfigClient) APICollectionsOffboardAzureApiManagementApi(ctx context.Context, id ApiCollectionId) (result APICollectionsOffboardAzureApiManagementApiOperationResponse, err error)

APICollectionsOffboardAzureApiManagementApi ...

func (APIMConfigClient) APICollectionsOnboardAzureApiManagementApi

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

APICollectionsOnboardAzureApiManagementApi ...

func (APIMConfigClient) APICollectionsOnboardAzureApiManagementApiThenPoll

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

APICollectionsOnboardAzureApiManagementApiThenPoll performs APICollectionsOnboardAzureApiManagementApi then polls until it's completed

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

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

func (ApiCollectionOperationPredicate) Matches

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 ProvisioningState

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

type ServiceId

type ServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID

func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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

func (ServiceId) ID

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Service ID

func (ServiceId) String

func (id ServiceId) String() string

String returns a human-readable description of this Service ID

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL