README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2021-08-01/policydescription
Documentation
The policydescription
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/policydescription"
Client Initialization
client := policydescription.NewPolicyDescriptionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: PolicyDescriptionClient.ListByService
ctx := context.TODO()
id := policydescription.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
read, err := client.ListByService(ctx, id, policydescription.DefaultListByServiceOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func PossibleValuesForPolicyScopeContract() []string
- func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
- type ListByServiceOperationOptions
- type ListByServiceOperationResponse
- type PolicyDescriptionClient
- type PolicyDescriptionCollection
- type PolicyDescriptionContract
- type PolicyDescriptionContractProperties
- type PolicyScopeContract
- type ServiceId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForPolicyScopeContract ¶
func PossibleValuesForPolicyScopeContract() []string
func ValidateServiceID ¶
ValidateServiceID checks that 'input' can be parsed as a Service ID
Types ¶
type ListByServiceOperationOptions ¶
type ListByServiceOperationOptions struct {
Scope *PolicyScopeContract
}
func DefaultListByServiceOperationOptions ¶
func DefaultListByServiceOperationOptions() ListByServiceOperationOptions
type ListByServiceOperationResponse ¶
type ListByServiceOperationResponse struct { HttpResponse *http.Response Model *PolicyDescriptionCollection }
type PolicyDescriptionClient ¶
type PolicyDescriptionClient struct { Client autorest.Client // contains filtered or unexported fields }
func NewPolicyDescriptionClientWithBaseURI ¶
func NewPolicyDescriptionClientWithBaseURI(endpoint string) PolicyDescriptionClient
func (PolicyDescriptionClient) ListByService ¶
func (c PolicyDescriptionClient) ListByService(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
ListByService ...
type PolicyDescriptionCollection ¶
type PolicyDescriptionCollection struct { Count *int64 `json:"count,omitempty"` Value *[]PolicyDescriptionContract `json:"value,omitempty"` }
type PolicyDescriptionContract ¶
type PolicyDescriptionContract struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *PolicyDescriptionContractProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type PolicyScopeContract ¶
type PolicyScopeContract string
const ( PolicyScopeContractAll PolicyScopeContract = "All" PolicyScopeContractApi PolicyScopeContract = "Api" PolicyScopeContractOperation PolicyScopeContract = "Operation" PolicyScopeContractProduct PolicyScopeContract = "Product" PolicyScopeContractTenant PolicyScopeContract = "Tenant" )
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