README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2023-03-01-preview/tenantaccess
Documentation
The tenantaccess
SDK allows for interaction with the Azure Resource Manager Service apimanagement
(API Version 2023-03-01-preview
).
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/2023-03-01-preview/tenantaccess"
Client Initialization
client := tenantaccess.NewTenantAccessClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: TenantAccessClient.Create
ctx := context.TODO()
id := tenantaccess.NewAccessID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "access")
payload := tenantaccess.AccessInformationCreateParameters{
// ...
}
read, err := client.Create(ctx, id, payload, tenantaccess.DefaultCreateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: TenantAccessClient.Get
ctx := context.TODO()
id := tenantaccess.NewAccessID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "access")
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: TenantAccessClient.GetEntityTag
ctx := context.TODO()
id := tenantaccess.NewAccessID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "access")
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: TenantAccessClient.ListByService
ctx := context.TODO()
id := tenantaccess.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
// alternatively `client.ListByService(ctx, id, tenantaccess.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, tenantaccess.DefaultListByServiceOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: TenantAccessClient.ListSecrets
ctx := context.TODO()
id := tenantaccess.NewAccessID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "access")
read, err := client.ListSecrets(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: TenantAccessClient.RegeneratePrimaryKey
ctx := context.TODO()
id := tenantaccess.NewAccessID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "access")
read, err := client.RegeneratePrimaryKey(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: TenantAccessClient.RegenerateSecondaryKey
ctx := context.TODO()
id := tenantaccess.NewAccessID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "access")
read, err := client.RegenerateSecondaryKey(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: TenantAccessClient.Update
ctx := context.TODO()
id := tenantaccess.NewAccessID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "access")
payload := tenantaccess.AccessInformationUpdateParameters{
// ...
}
read, err := client.Update(ctx, id, payload, tenantaccess.DefaultUpdateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func PossibleValuesForAccessIdName() []string
- func ValidateAccessID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
- type AccessId
- type AccessIdName
- type AccessInformationContract
- type AccessInformationContractOperationPredicate
- type AccessInformationContractProperties
- type AccessInformationCreateParameterProperties
- type AccessInformationCreateParameters
- type AccessInformationSecretsContract
- type AccessInformationUpdateParameterProperties
- type AccessInformationUpdateParameters
- type CreateOperationOptions
- type CreateOperationResponse
- type GetEntityTagOperationResponse
- type GetOperationResponse
- type ListByServiceCompleteResult
- type ListByServiceOperationOptions
- type ListByServiceOperationResponse
- type ListSecretsOperationResponse
- type RegeneratePrimaryKeyOperationResponse
- type RegenerateSecondaryKeyOperationResponse
- type ServiceId
- type TenantAccessClient
- func (c TenantAccessClient) Create(ctx context.Context, id AccessId, input AccessInformationCreateParameters, ...) (result CreateOperationResponse, err error)
- func (c TenantAccessClient) Get(ctx context.Context, id AccessId) (result GetOperationResponse, err error)
- func (c TenantAccessClient) GetEntityTag(ctx context.Context, id AccessId) (result GetEntityTagOperationResponse, err error)
- func (c TenantAccessClient) ListByService(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
- func (c TenantAccessClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
- func (c TenantAccessClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, ...) (result ListByServiceCompleteResult, err error)
- func (c TenantAccessClient) ListSecrets(ctx context.Context, id AccessId) (result ListSecretsOperationResponse, err error)
- func (c TenantAccessClient) RegeneratePrimaryKey(ctx context.Context, id AccessId) (result RegeneratePrimaryKeyOperationResponse, err error)
- func (c TenantAccessClient) RegenerateSecondaryKey(ctx context.Context, id AccessId) (result RegenerateSecondaryKeyOperationResponse, err error)
- func (c TenantAccessClient) Update(ctx context.Context, id AccessId, input AccessInformationUpdateParameters, ...) (result UpdateOperationResponse, err error)
- type UpdateOperationOptions
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForAccessIdName ¶
func PossibleValuesForAccessIdName() []string
func ValidateAccessID ¶
ValidateAccessID checks that 'input' can be parsed as a Access ID
func ValidateServiceID ¶
ValidateServiceID checks that 'input' can be parsed as a Service ID
Types ¶
type AccessId ¶
type AccessId struct { SubscriptionId string ResourceGroupName string ServiceName string AccessName AccessIdName }
AccessId is a struct representing the Resource ID for a Access
func NewAccessID ¶
func NewAccessID(subscriptionId string, resourceGroupName string, serviceName string, accessName AccessIdName) AccessId
NewAccessID returns a new AccessId struct
func ParseAccessID ¶
ParseAccessID parses 'input' into a AccessId
func ParseAccessIDInsensitively ¶
ParseAccessIDInsensitively parses 'input' case-insensitively into a AccessId note: this method should only be used for API response data and not user input
func (*AccessId) FromParseResult ¶
func (id *AccessId) FromParseResult(input resourceids.ParseResult) error
func (AccessId) Segments ¶
func (id AccessId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Access ID
type AccessIdName ¶
type AccessIdName string
const ( AccessIdNameAccess AccessIdName = "access" AccessIdNameGitAccess AccessIdName = "gitAccess" )
func (*AccessIdName) UnmarshalJSON ¶
func (s *AccessIdName) UnmarshalJSON(bytes []byte) error
type AccessInformationContract ¶
type AccessInformationContract struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *AccessInformationContractProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type AccessInformationContractOperationPredicate ¶
func (AccessInformationContractOperationPredicate) Matches ¶
func (p AccessInformationContractOperationPredicate) Matches(input AccessInformationContract) bool
type AccessInformationCreateParameters ¶
type AccessInformationCreateParameters struct {
Properties *AccessInformationCreateParameterProperties `json:"properties,omitempty"`
}
type AccessInformationUpdateParameterProperties ¶
type AccessInformationUpdateParameterProperties struct {
Enabled *bool `json:"enabled,omitempty"`
}
type AccessInformationUpdateParameters ¶
type AccessInformationUpdateParameters struct {
Properties *AccessInformationUpdateParameterProperties `json:"properties,omitempty"`
}
type CreateOperationOptions ¶
type CreateOperationOptions struct {
IfMatch *string
}
func DefaultCreateOperationOptions ¶
func DefaultCreateOperationOptions() CreateOperationOptions
func (CreateOperationOptions) ToHeaders ¶
func (o CreateOperationOptions) ToHeaders() *client.Headers
func (CreateOperationOptions) ToOData ¶
func (o CreateOperationOptions) ToOData() *odata.Query
func (CreateOperationOptions) ToQuery ¶
func (o CreateOperationOptions) ToQuery() *client.QueryParams
type CreateOperationResponse ¶
type CreateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *AccessInformationContract }
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *AccessInformationContract }
type ListByServiceCompleteResult ¶
type ListByServiceCompleteResult struct { LatestHttpResponse *http.Response Items []AccessInformationContract }
type ListByServiceOperationOptions ¶
type ListByServiceOperationOptions struct {
Filter *string
}
func DefaultListByServiceOperationOptions ¶
func DefaultListByServiceOperationOptions() ListByServiceOperationOptions
func (ListByServiceOperationOptions) ToHeaders ¶
func (o ListByServiceOperationOptions) ToHeaders() *client.Headers
func (ListByServiceOperationOptions) ToOData ¶
func (o ListByServiceOperationOptions) ToOData() *odata.Query
func (ListByServiceOperationOptions) ToQuery ¶
func (o ListByServiceOperationOptions) ToQuery() *client.QueryParams
type ListByServiceOperationResponse ¶
type ListByServiceOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]AccessInformationContract }
type ListSecretsOperationResponse ¶
type ListSecretsOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *AccessInformationSecretsContract }
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) FromParseResult ¶
func (id *ServiceId) FromParseResult(input resourceids.ParseResult) error
func (ServiceId) Segments ¶
func (id ServiceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Service ID
type TenantAccessClient ¶
type TenantAccessClient struct {
Client *resourcemanager.Client
}
func NewTenantAccessClientWithBaseURI ¶
func NewTenantAccessClientWithBaseURI(sdkApi sdkEnv.Api) (*TenantAccessClient, error)
func (TenantAccessClient) Create ¶
func (c TenantAccessClient) Create(ctx context.Context, id AccessId, input AccessInformationCreateParameters, options CreateOperationOptions) (result CreateOperationResponse, err error)
Create ...
func (TenantAccessClient) Get ¶
func (c TenantAccessClient) Get(ctx context.Context, id AccessId) (result GetOperationResponse, err error)
Get ...
func (TenantAccessClient) GetEntityTag ¶
func (c TenantAccessClient) GetEntityTag(ctx context.Context, id AccessId) (result GetEntityTagOperationResponse, err error)
GetEntityTag ...
func (TenantAccessClient) ListByService ¶
func (c TenantAccessClient) ListByService(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
ListByService ...
func (TenantAccessClient) ListByServiceComplete ¶
func (c TenantAccessClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
ListByServiceComplete retrieves all the results into a single object
func (TenantAccessClient) ListByServiceCompleteMatchingPredicate ¶
func (c TenantAccessClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, predicate AccessInformationContractOperationPredicate) (result ListByServiceCompleteResult, err error)
ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (TenantAccessClient) ListSecrets ¶
func (c TenantAccessClient) ListSecrets(ctx context.Context, id AccessId) (result ListSecretsOperationResponse, err error)
ListSecrets ...
func (TenantAccessClient) RegeneratePrimaryKey ¶
func (c TenantAccessClient) RegeneratePrimaryKey(ctx context.Context, id AccessId) (result RegeneratePrimaryKeyOperationResponse, err error)
RegeneratePrimaryKey ...
func (TenantAccessClient) RegenerateSecondaryKey ¶
func (c TenantAccessClient) RegenerateSecondaryKey(ctx context.Context, id AccessId) (result RegenerateSecondaryKeyOperationResponse, err error)
RegenerateSecondaryKey ...
func (TenantAccessClient) Update ¶
func (c TenantAccessClient) Update(ctx context.Context, id AccessId, input AccessInformationUpdateParameters, options UpdateOperationOptions) (result UpdateOperationResponse, err error)
Update ...
type UpdateOperationOptions ¶
type UpdateOperationOptions struct {
IfMatch *string
}
func DefaultUpdateOperationOptions ¶
func DefaultUpdateOperationOptions() UpdateOperationOptions
func (UpdateOperationOptions) ToHeaders ¶
func (o UpdateOperationOptions) ToHeaders() *client.Headers
func (UpdateOperationOptions) ToOData ¶
func (o UpdateOperationOptions) ToOData() *odata.Query
func (UpdateOperationOptions) ToQuery ¶
func (o UpdateOperationOptions) ToQuery() *client.QueryParams
type UpdateOperationResponse ¶
type UpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *AccessInformationContract }
Source Files ¶
- client.go
- constants.go
- id_access.go
- id_service.go
- method_create.go
- method_get.go
- method_getentitytag.go
- method_listbyservice.go
- method_listsecrets.go
- method_regenerateprimarykey.go
- method_regeneratesecondarykey.go
- method_update.go
- model_accessinformationcontract.go
- model_accessinformationcontractproperties.go
- model_accessinformationcreateparameterproperties.go
- model_accessinformationcreateparameters.go
- model_accessinformationsecretscontract.go
- model_accessinformationupdateparameterproperties.go
- model_accessinformationupdateparameters.go
- predicates.go
- version.go