productpolicy

package
v0.20241111.1164443 Latest Latest
Warning

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

 Go to latest Published: Nov 11, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2024-05-01/productpolicy Documentation

The productpolicy SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2024-05-01).

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/apimanagement/2024-05-01/productpolicy"

Client Initialization

client := productpolicy.NewProductPolicyClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ProductPolicyClient.CreateOrUpdate

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

payload := productpolicy.PolicyContract{
	// ...
}


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

Example Usage: ProductPolicyClient.Delete

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

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

Example Usage: ProductPolicyClient.Get

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

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

Example Usage: ProductPolicyClient.GetEntityTag

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

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

Example Usage: ProductPolicyClient.ListByProduct

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

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

Example Usage: ProductPolicyClient.WorkspaceProductPolicyCreateOrUpdate

ctx := context.TODO()
id := productpolicy.NewWorkspaceProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "productId")

payload := productpolicy.PolicyContract{
	// ...
}


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

Example Usage: ProductPolicyClient.WorkspaceProductPolicyDelete

ctx := context.TODO()
id := productpolicy.NewWorkspaceProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "productId")

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

Example Usage: ProductPolicyClient.WorkspaceProductPolicyGet

ctx := context.TODO()
id := productpolicy.NewWorkspaceProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "productId")

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

Example Usage: ProductPolicyClient.WorkspaceProductPolicyGetEntityTag

ctx := context.TODO()
id := productpolicy.NewWorkspaceProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "productId")

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

Example Usage: ProductPolicyClient.WorkspaceProductPolicyListByProduct

ctx := context.TODO()
id := productpolicy.NewWorkspaceProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "productId")

// alternatively `client.WorkspaceProductPolicyListByProduct(ctx, id)` can be used to do batched pagination
items, err := client.WorkspaceProductPolicyListByProductComplete(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 PossibleValuesForPolicyContentFormat 

func PossibleValuesForPolicyContentFormat() []string

func PossibleValuesForPolicyExportFormat 

func PossibleValuesForPolicyExportFormat() []string

func ValidateProductID 

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

ValidateProductID checks that 'input' can be parsed as a Product ID

func ValidateWorkspaceProductID 

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

ValidateWorkspaceProductID checks that 'input' can be parsed as a Workspace Product ID

Types

type CreateOrUpdateOperationOptions 

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders 

func (o CreateOrUpdateOperationOptions) ToHeaders() *client.Headers

func (CreateOrUpdateOperationOptions) ToOData 

func (o CreateOrUpdateOperationOptions) ToOData() *odata.Query

func (CreateOrUpdateOperationOptions) ToQuery 

func (o CreateOrUpdateOperationOptions) ToQuery() *client.QueryParams

type CreateOrUpdateOperationResponse 

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

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders 

func (o DeleteOperationOptions) ToHeaders() *client.Headers

func (DeleteOperationOptions) ToOData 

func (o DeleteOperationOptions) ToOData() *odata.Query

func (DeleteOperationOptions) ToQuery 

func (o DeleteOperationOptions) ToQuery() *client.QueryParams

type DeleteOperationResponse 

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

type GetEntityTagOperationResponse 

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

type GetOperationOptions 

type GetOperationOptions struct {
	Format *PolicyExportFormat
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders 

func (o GetOperationOptions) ToHeaders() *client.Headers

func (GetOperationOptions) ToOData 

func (o GetOperationOptions) ToOData() *odata.Query

func (GetOperationOptions) ToQuery 

func (o GetOperationOptions) ToQuery() *client.QueryParams

type GetOperationResponse 

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

type ListByProductCompleteResult 

type ListByProductCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PolicyContract
}

type ListByProductCustomPager 

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

type ListByProductOperationResponse 

type ListByProductOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PolicyContract
}

type PolicyContentFormat 

type PolicyContentFormat string
const (
	PolicyContentFormatRawxml             PolicyContentFormat = "rawxml"
	PolicyContentFormatRawxmlNegativelink PolicyContentFormat = "rawxml-link"
	PolicyContentFormatXml                PolicyContentFormat = "xml"
	PolicyContentFormatXmlNegativelink    PolicyContentFormat = "xml-link"
)

func (*PolicyContentFormat) UnmarshalJSON 

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

type PolicyContract 

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

type PolicyContractOperationPredicate 

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

func (PolicyContractOperationPredicate) Matches 

func (p PolicyContractOperationPredicate) Matches(input PolicyContract) bool

type PolicyContractProperties 

type PolicyContractProperties struct {
	Format *PolicyContentFormat `json:"format,omitempty"`
	Value  string               `json:"value"`
}

type PolicyExportFormat 

type PolicyExportFormat string
const (
	PolicyExportFormatRawxml PolicyExportFormat = "rawxml"
	PolicyExportFormatXml    PolicyExportFormat = "xml"
)

func (*PolicyExportFormat) UnmarshalJSON 

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

type ProductId 

type ProductId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ProductId         string
}

ProductId is a struct representing the Resource ID for a Product

func NewProductID 

func NewProductID(subscriptionId string, resourceGroupName string, serviceName string, productId string) ProductId

NewProductID returns a new ProductId struct

func ParseProductID 

func ParseProductID(input string) (*ProductId, error)

ParseProductID parses 'input' into a ProductId

func ParseProductIDInsensitively 

func ParseProductIDInsensitively(input string) (*ProductId, error)

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

func (*ProductId) FromParseResult 

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

func (ProductId) ID 

func (id ProductId) ID() string

ID returns the formatted Product ID

func (ProductId) Segments 

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

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

func (ProductId) String 

func (id ProductId) String() string

String returns a human-readable description of this Product ID

type ProductPolicyClient 

type ProductPolicyClient struct {
	Client *resourcemanager.Client
}

func NewProductPolicyClientWithBaseURI 

func NewProductPolicyClientWithBaseURI(sdkApi sdkEnv.Api) (*ProductPolicyClient, error)

func (ProductPolicyClient) CreateOrUpdate 

func (c ProductPolicyClient) CreateOrUpdate(ctx context.Context, id ProductId, input PolicyContract, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ProductPolicyClient) Delete 

func (c ProductPolicyClient) Delete(ctx context.Context, id ProductId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (ProductPolicyClient) Get 

func (c ProductPolicyClient) Get(ctx context.Context, id ProductId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (ProductPolicyClient) GetEntityTag 

func (c ProductPolicyClient) GetEntityTag(ctx context.Context, id ProductId) (result GetEntityTagOperationResponse, err error)

GetEntityTag ...

func (ProductPolicyClient) ListByProduct 

func (c ProductPolicyClient) ListByProduct(ctx context.Context, id ProductId) (result ListByProductOperationResponse, err error)

ListByProduct ...

func (ProductPolicyClient) ListByProductComplete 

func (c ProductPolicyClient) ListByProductComplete(ctx context.Context, id ProductId) (ListByProductCompleteResult, error)

ListByProductComplete retrieves all the results into a single object

func (ProductPolicyClient) ListByProductCompleteMatchingPredicate 

func (c ProductPolicyClient) ListByProductCompleteMatchingPredicate(ctx context.Context, id ProductId, predicate PolicyContractOperationPredicate) (result ListByProductCompleteResult, err error)

ListByProductCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ProductPolicyClient) WorkspaceProductPolicyCreateOrUpdate 

func (c ProductPolicyClient) WorkspaceProductPolicyCreateOrUpdate(ctx context.Context, id WorkspaceProductId, input PolicyContract, options WorkspaceProductPolicyCreateOrUpdateOperationOptions) (result WorkspaceProductPolicyCreateOrUpdateOperationResponse, err error)

WorkspaceProductPolicyCreateOrUpdate ...

func (ProductPolicyClient) WorkspaceProductPolicyDelete 

func (c ProductPolicyClient) WorkspaceProductPolicyDelete(ctx context.Context, id WorkspaceProductId, options WorkspaceProductPolicyDeleteOperationOptions) (result WorkspaceProductPolicyDeleteOperationResponse, err error)

WorkspaceProductPolicyDelete ...

func (ProductPolicyClient) WorkspaceProductPolicyGet 

func (c ProductPolicyClient) WorkspaceProductPolicyGet(ctx context.Context, id WorkspaceProductId, options WorkspaceProductPolicyGetOperationOptions) (result WorkspaceProductPolicyGetOperationResponse, err error)

WorkspaceProductPolicyGet ...

func (ProductPolicyClient) WorkspaceProductPolicyGetEntityTag 

func (c ProductPolicyClient) WorkspaceProductPolicyGetEntityTag(ctx context.Context, id WorkspaceProductId) (result WorkspaceProductPolicyGetEntityTagOperationResponse, err error)

WorkspaceProductPolicyGetEntityTag ...

func (ProductPolicyClient) WorkspaceProductPolicyListByProduct 

func (c ProductPolicyClient) WorkspaceProductPolicyListByProduct(ctx context.Context, id WorkspaceProductId) (result WorkspaceProductPolicyListByProductOperationResponse, err error)

WorkspaceProductPolicyListByProduct ...

func (ProductPolicyClient) WorkspaceProductPolicyListByProductComplete 

func (c ProductPolicyClient) WorkspaceProductPolicyListByProductComplete(ctx context.Context, id WorkspaceProductId) (WorkspaceProductPolicyListByProductCompleteResult, error)

WorkspaceProductPolicyListByProductComplete retrieves all the results into a single object

func (ProductPolicyClient) WorkspaceProductPolicyListByProductCompleteMatchingPredicate 

func (c ProductPolicyClient) WorkspaceProductPolicyListByProductCompleteMatchingPredicate(ctx context.Context, id WorkspaceProductId, predicate PolicyContractOperationPredicate) (result WorkspaceProductPolicyListByProductCompleteResult, err error)

WorkspaceProductPolicyListByProductCompleteMatchingPredicate retrieves all the results and then applies the predicate

type WorkspaceProductId 

type WorkspaceProductId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	WorkspaceId       string
	ProductId         string
}

WorkspaceProductId is a struct representing the Resource ID for a Workspace Product

func NewWorkspaceProductID 

func NewWorkspaceProductID(subscriptionId string, resourceGroupName string, serviceName string, workspaceId string, productId string) WorkspaceProductId

NewWorkspaceProductID returns a new WorkspaceProductId struct

func ParseWorkspaceProductID 

func ParseWorkspaceProductID(input string) (*WorkspaceProductId, error)

ParseWorkspaceProductID parses 'input' into a WorkspaceProductId

func ParseWorkspaceProductIDInsensitively 

func ParseWorkspaceProductIDInsensitively(input string) (*WorkspaceProductId, error)

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

func (*WorkspaceProductId) FromParseResult 

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

func (WorkspaceProductId) ID 

func (id WorkspaceProductId) ID() string

ID returns the formatted Workspace Product ID

func (WorkspaceProductId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Workspace Product ID

func (WorkspaceProductId) String 

func (id WorkspaceProductId) String() string

String returns a human-readable description of this Workspace Product ID

type WorkspaceProductPolicyCreateOrUpdateOperationOptions 

type WorkspaceProductPolicyCreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultWorkspaceProductPolicyCreateOrUpdateOperationOptions 

func DefaultWorkspaceProductPolicyCreateOrUpdateOperationOptions() WorkspaceProductPolicyCreateOrUpdateOperationOptions

func (WorkspaceProductPolicyCreateOrUpdateOperationOptions) ToHeaders 

func (o WorkspaceProductPolicyCreateOrUpdateOperationOptions) ToHeaders() *client.Headers

func (WorkspaceProductPolicyCreateOrUpdateOperationOptions) ToOData 

func (o WorkspaceProductPolicyCreateOrUpdateOperationOptions) ToOData() *odata.Query

func (WorkspaceProductPolicyCreateOrUpdateOperationOptions) ToQuery 

func (o WorkspaceProductPolicyCreateOrUpdateOperationOptions) ToQuery() *client.QueryParams

type WorkspaceProductPolicyCreateOrUpdateOperationResponse 

type WorkspaceProductPolicyCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PolicyContract
}

type WorkspaceProductPolicyDeleteOperationOptions 

type WorkspaceProductPolicyDeleteOperationOptions struct {
	IfMatch *string
}

func DefaultWorkspaceProductPolicyDeleteOperationOptions 

func DefaultWorkspaceProductPolicyDeleteOperationOptions() WorkspaceProductPolicyDeleteOperationOptions

func (WorkspaceProductPolicyDeleteOperationOptions) ToHeaders 

func (o WorkspaceProductPolicyDeleteOperationOptions) ToHeaders() *client.Headers

func (WorkspaceProductPolicyDeleteOperationOptions) ToOData 

func (o WorkspaceProductPolicyDeleteOperationOptions) ToOData() *odata.Query

func (WorkspaceProductPolicyDeleteOperationOptions) ToQuery 

func (o WorkspaceProductPolicyDeleteOperationOptions) ToQuery() *client.QueryParams

type WorkspaceProductPolicyDeleteOperationResponse 

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

type WorkspaceProductPolicyGetEntityTagOperationResponse 

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

type WorkspaceProductPolicyGetOperationOptions 

type WorkspaceProductPolicyGetOperationOptions struct {
	Format *PolicyExportFormat
}

func DefaultWorkspaceProductPolicyGetOperationOptions 

func DefaultWorkspaceProductPolicyGetOperationOptions() WorkspaceProductPolicyGetOperationOptions

func (WorkspaceProductPolicyGetOperationOptions) ToHeaders 

func (o WorkspaceProductPolicyGetOperationOptions) ToHeaders() *client.Headers

func (WorkspaceProductPolicyGetOperationOptions) ToOData 

func (o WorkspaceProductPolicyGetOperationOptions) ToOData() *odata.Query

func (WorkspaceProductPolicyGetOperationOptions) ToQuery 

func (o WorkspaceProductPolicyGetOperationOptions) ToQuery() *client.QueryParams

type WorkspaceProductPolicyGetOperationResponse 

type WorkspaceProductPolicyGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PolicyContract
}

type WorkspaceProductPolicyListByProductCompleteResult 

type WorkspaceProductPolicyListByProductCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PolicyContract
}

type WorkspaceProductPolicyListByProductCustomPager 

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

type WorkspaceProductPolicyListByProductOperationResponse 

type WorkspaceProductPolicyListByProductOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PolicyContract
}

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.