README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2021-08-01/policy
Documentation
The policy
SDK allows for interaction with the Azure Resource Manager Service apimanagement
(API Version 2021-08-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/2021-08-01/policy"
Client Initialization
client := policy.NewPolicyClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: PolicyClient.CreateOrUpdate
ctx := context.TODO()
id := policy.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
payload := policy.PolicyContract{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload, policy.DefaultCreateOrUpdateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: PolicyClient.Delete
ctx := context.TODO()
id := policy.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
read, err := client.Delete(ctx, id, policy.DefaultDeleteOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: PolicyClient.Get
ctx := context.TODO()
id := policy.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
read, err := client.Get(ctx, id, policy.DefaultGetOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: PolicyClient.GetEntityTag
ctx := context.TODO()
id := policy.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
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: PolicyClient.ListByService
ctx := context.TODO()
id := policy.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
read, err := client.ListByService(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func PossibleValuesForPolicyContentFormat() []string
- func PossibleValuesForPolicyExportFormat() []string
- func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationOptions
- type CreateOrUpdateOperationResponse
- type DeleteOperationOptions
- type DeleteOperationResponse
- type GetEntityTagOperationResponse
- type GetOperationOptions
- type GetOperationResponse
- type ListByServiceOperationResponse
- type PolicyClient
- func (c PolicyClient) CreateOrUpdate(ctx context.Context, id ServiceId, input PolicyContract, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c PolicyClient) Delete(ctx context.Context, id ServiceId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
- func (c PolicyClient) Get(ctx context.Context, id ServiceId, options GetOperationOptions) (result GetOperationResponse, err error)
- func (c PolicyClient) GetEntityTag(ctx context.Context, id ServiceId) (result GetEntityTagOperationResponse, err error)
- func (c PolicyClient) ListByService(ctx context.Context, id ServiceId) (result ListByServiceOperationResponse, err error)
- type PolicyCollection
- type PolicyContentFormat
- type PolicyContract
- type PolicyContractProperties
- type PolicyExportFormat
- type ServiceId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForPolicyContentFormat ¶
func PossibleValuesForPolicyContentFormat() []string
func PossibleValuesForPolicyExportFormat ¶
func PossibleValuesForPolicyExportFormat() []string
func ValidateServiceID ¶
ValidateServiceID checks that 'input' can be parsed as a Service ID
Types ¶
type CreateOrUpdateOperationOptions ¶
type CreateOrUpdateOperationOptions struct {
IfMatch *string
}
func DefaultCreateOrUpdateOperationOptions ¶
func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions
func (CreateOrUpdateOperationOptions) ToHeaders ¶ added in v0.20230801.1071415
func (o CreateOrUpdateOperationOptions) ToHeaders() *client.Headers
func (CreateOrUpdateOperationOptions) ToOData ¶ added in v0.20230801.1071415
func (o CreateOrUpdateOperationOptions) ToOData() *odata.Query
func (CreateOrUpdateOperationOptions) ToQuery ¶ added in v0.20230801.1071415
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 ¶ added in v0.20230801.1071415
func (o DeleteOperationOptions) ToHeaders() *client.Headers
func (DeleteOperationOptions) ToOData ¶ added in v0.20230801.1071415
func (o DeleteOperationOptions) ToOData() *odata.Query
func (DeleteOperationOptions) ToQuery ¶ added in v0.20230801.1071415
func (o DeleteOperationOptions) ToQuery() *client.QueryParams
type DeleteOperationResponse ¶
type GetOperationOptions ¶
type GetOperationOptions struct {
Format *PolicyExportFormat
}
func DefaultGetOperationOptions ¶
func DefaultGetOperationOptions() GetOperationOptions
func (GetOperationOptions) ToHeaders ¶ added in v0.20230801.1071415
func (o GetOperationOptions) ToHeaders() *client.Headers
func (GetOperationOptions) ToOData ¶ added in v0.20230801.1071415
func (o GetOperationOptions) ToOData() *odata.Query
func (GetOperationOptions) ToQuery ¶ added in v0.20230801.1071415
func (o GetOperationOptions) ToQuery() *client.QueryParams
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PolicyContract }
type ListByServiceOperationResponse ¶
type ListByServiceOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PolicyCollection }
type PolicyClient ¶
type PolicyClient struct {
Client *resourcemanager.Client
}
func NewPolicyClientWithBaseURI ¶
func NewPolicyClientWithBaseURI(sdkApi sdkEnv.Api) (*PolicyClient, error)
func (PolicyClient) CreateOrUpdate ¶
func (c PolicyClient) CreateOrUpdate(ctx context.Context, id ServiceId, input PolicyContract, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (PolicyClient) Delete ¶
func (c PolicyClient) Delete(ctx context.Context, id ServiceId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
Delete ...
func (PolicyClient) Get ¶
func (c PolicyClient) Get(ctx context.Context, id ServiceId, options GetOperationOptions) (result GetOperationResponse, err error)
Get ...
func (PolicyClient) GetEntityTag ¶
func (c PolicyClient) GetEntityTag(ctx context.Context, id ServiceId) (result GetEntityTagOperationResponse, err error)
GetEntityTag ...
func (PolicyClient) ListByService ¶
func (c PolicyClient) ListByService(ctx context.Context, id ServiceId) (result ListByServiceOperationResponse, err error)
ListByService ...
type PolicyCollection ¶
type PolicyCollection struct { Count *int64 `json:"count,omitempty"` NextLink *string `json:"nextLink,omitempty"` Value *[]PolicyContract `json:"value,omitempty"` }
type PolicyContentFormat ¶
type PolicyContentFormat string
const ( PolicyContentFormatRawxml PolicyContentFormat = "rawxml" PolicyContentFormatRawxmlNegativelink PolicyContentFormat = "rawxml-link" PolicyContentFormatXml PolicyContentFormat = "xml" PolicyContentFormatXmlNegativelink PolicyContentFormat = "xml-link" )
func (*PolicyContentFormat) UnmarshalJSON ¶ added in v0.20230801.1071415
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 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 ¶ added in v0.20230801.1071415
func (s *PolicyExportFormat) UnmarshalJSON(bytes []byte) error
type ServiceId ¶
ServiceId is a struct representing the Resource ID for a Service
func NewServiceID ¶
NewServiceID returns a new ServiceId struct
func ParseServiceID ¶
ParseServiceID parses 'input' into a ServiceId
func ParseServiceIDInsensitively ¶
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) Segments ¶
func (id ServiceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Service ID