d4apicollectionlist

package
v0.20241126.1110949 Latest Latest
Warning

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

 Go to latest Published: Nov 26, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

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

The d4apicollectionlist SDK allows for interaction with Azure Resource Manager 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/security/2023-11-15/d4apicollectionlist"

Client Initialization

client := d4apicollectionlist.NewD4APICollectionListClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: D4APICollectionListClient.APICollectionsListByAzureApiManagementService

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

// 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: D4APICollectionListClient.APICollectionsListByResourceGroup

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

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

Example Usage: D4APICollectionListClient.APICollectionsListBySubscription

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

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 APICollectionsListByAzureApiManagementServiceCompleteResult 

type APICollectionsListByAzureApiManagementServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApiCollection
}

type APICollectionsListByAzureApiManagementServiceCustomPager added in v0.20240628.1153531 

type APICollectionsListByAzureApiManagementServiceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *APICollectionsListByAzureApiManagementServiceCustomPager) NextPageLink() *odata.Link

type APICollectionsListByAzureApiManagementServiceOperationResponse 

type APICollectionsListByAzureApiManagementServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApiCollection
}

type APICollectionsListByResourceGroupCompleteResult 

type APICollectionsListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApiCollection
}

type APICollectionsListByResourceGroupCustomPager added in v0.20240628.1153531 

type APICollectionsListByResourceGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *APICollectionsListByResourceGroupCustomPager) NextPageLink() *odata.Link

type APICollectionsListByResourceGroupOperationResponse 

type APICollectionsListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApiCollection
}

type APICollectionsListBySubscriptionCompleteResult 

type APICollectionsListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApiCollection
}

type APICollectionsListBySubscriptionCustomPager added in v0.20240628.1153531 

type APICollectionsListBySubscriptionCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *APICollectionsListBySubscriptionCustomPager) NextPageLink() *odata.Link

type APICollectionsListBySubscriptionOperationResponse 

type APICollectionsListBySubscriptionOperationResponse struct {
	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 ApiCollectionOperationPredicate 

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

func (ApiCollectionOperationPredicate) Matches 

func (p ApiCollectionOperationPredicate) Matches(input ApiCollection) bool

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 D4APICollectionListClient 

type D4APICollectionListClient struct {
	Client *resourcemanager.Client
}

func NewD4APICollectionListClientWithBaseURI 

func NewD4APICollectionListClientWithBaseURI(sdkApi sdkEnv.Api) (*D4APICollectionListClient, error)

func (D4APICollectionListClient) APICollectionsListByAzureApiManagementService 

func (c D4APICollectionListClient) APICollectionsListByAzureApiManagementService(ctx context.Context, id ServiceId) (result APICollectionsListByAzureApiManagementServiceOperationResponse, err error)

APICollectionsListByAzureApiManagementService ...

func (D4APICollectionListClient) APICollectionsListByAzureApiManagementServiceComplete 

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

APICollectionsListByAzureApiManagementServiceComplete retrieves all the results into a single object

func (D4APICollectionListClient) APICollectionsListByAzureApiManagementServiceCompleteMatchingPredicate 

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

APICollectionsListByAzureApiManagementServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (D4APICollectionListClient) APICollectionsListByResourceGroup 

func (c D4APICollectionListClient) APICollectionsListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result APICollectionsListByResourceGroupOperationResponse, err error)

APICollectionsListByResourceGroup ...

func (D4APICollectionListClient) APICollectionsListByResourceGroupComplete 

func (c D4APICollectionListClient) APICollectionsListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (APICollectionsListByResourceGroupCompleteResult, error)

APICollectionsListByResourceGroupComplete retrieves all the results into a single object

func (D4APICollectionListClient) APICollectionsListByResourceGroupCompleteMatchingPredicate 

func (c D4APICollectionListClient) APICollectionsListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ApiCollectionOperationPredicate) (result APICollectionsListByResourceGroupCompleteResult, err error)

APICollectionsListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (D4APICollectionListClient) APICollectionsListBySubscription 

func (c D4APICollectionListClient) APICollectionsListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result APICollectionsListBySubscriptionOperationResponse, err error)

APICollectionsListBySubscription ...

func (D4APICollectionListClient) APICollectionsListBySubscriptionComplete 

func (c D4APICollectionListClient) APICollectionsListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (APICollectionsListBySubscriptionCompleteResult, error)

APICollectionsListBySubscriptionComplete retrieves all the results into a single object

func (D4APICollectionListClient) APICollectionsListBySubscriptionCompleteMatchingPredicate 

func (c D4APICollectionListClient) APICollectionsListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ApiCollectionOperationPredicate) (result APICollectionsListBySubscriptionCompleteResult, err error)

APICollectionsListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ProvisioningState 

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

func (*ProvisioningState) UnmarshalJSON added in v0.20240228.1142829 

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

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

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

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

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.