README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/tenantsettings
Documentation
The tenantsettings
SDK allows for interaction with the Azure Resource Manager Service apimanagement
(API Version 2022-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/2022-08-01/tenantsettings"
Client Initialization
client := tenantsettings.NewTenantSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: TenantSettingsClient.Get
ctx := context.TODO()
id := tenantsettings.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
read, err := client.Get(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: TenantSettingsClient.ListByService
ctx := context.TODO()
id := tenantsettings.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
// alternatively `client.ListByService(ctx, id, tenantsettings.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, tenantsettings.DefaultListByServiceOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
- type GetOperationResponse
- type ListByServiceCompleteResult
- type ListByServiceOperationOptions
- type ListByServiceOperationResponse
- type ServiceId
- type TenantSettingsClient
- func (c TenantSettingsClient) Get(ctx context.Context, id ServiceId) (result GetOperationResponse, err error)
- func (c TenantSettingsClient) ListByService(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
- func (c TenantSettingsClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
- func (c TenantSettingsClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, ...) (result ListByServiceCompleteResult, err error)
- type TenantSettingsContract
- type TenantSettingsContractOperationPredicate
- type TenantSettingsContractProperties
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateServiceID ¶
ValidateServiceID checks that 'input' can be parsed as a Service ID
Types ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *TenantSettingsContract }
type ListByServiceCompleteResult ¶
type ListByServiceCompleteResult struct {
Items []TenantSettingsContract
}
type ListByServiceOperationOptions ¶
type ListByServiceOperationOptions struct {
Filter *string
}
func DefaultListByServiceOperationOptions ¶
func DefaultListByServiceOperationOptions() ListByServiceOperationOptions
func (ListByServiceOperationOptions) ToHeaders ¶ added in v0.20230801.1071415
func (o ListByServiceOperationOptions) ToHeaders() *client.Headers
func (ListByServiceOperationOptions) ToOData ¶ added in v0.20230801.1071415
func (o ListByServiceOperationOptions) ToOData() *odata.Query
func (ListByServiceOperationOptions) ToQuery ¶ added in v0.20230801.1071415
func (o ListByServiceOperationOptions) ToQuery() *client.QueryParams
type ListByServiceOperationResponse ¶
type ListByServiceOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]TenantSettingsContract }
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
type TenantSettingsClient ¶
type TenantSettingsClient struct {
Client *resourcemanager.Client
}
func NewTenantSettingsClientWithBaseURI ¶
func NewTenantSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*TenantSettingsClient, error)
func (TenantSettingsClient) Get ¶
func (c TenantSettingsClient) Get(ctx context.Context, id ServiceId) (result GetOperationResponse, err error)
Get ...
func (TenantSettingsClient) ListByService ¶
func (c TenantSettingsClient) ListByService(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
ListByService ...
func (TenantSettingsClient) ListByServiceComplete ¶
func (c TenantSettingsClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
ListByServiceComplete retrieves all the results into a single object
func (TenantSettingsClient) ListByServiceCompleteMatchingPredicate ¶
func (c TenantSettingsClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, predicate TenantSettingsContractOperationPredicate) (result ListByServiceCompleteResult, err error)
ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate
type TenantSettingsContract ¶
type TenantSettingsContract struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *TenantSettingsContractProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type TenantSettingsContractOperationPredicate ¶
func (TenantSettingsContractOperationPredicate) Matches ¶
func (p TenantSettingsContractOperationPredicate) Matches(input TenantSettingsContract) bool