openidconnectprovider

package
v0.20220830.1105041 Latest Latest
Warning

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

 Go to latest Published: Aug 30, 2022 License: MPL-2.0 Imports: 8 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2021-08-01/openidconnectprovider Documentation

The openidconnectprovider 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/openidconnectprovider"

Client Initialization

client := openidconnectprovider.NewOpenidConnectProviderClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OpenidConnectProviderClient.OpenIdConnectProviderCreateOrUpdate

ctx := context.TODO()
id := openidconnectprovider.NewOpenidConnectProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "opidValue")

payload := openidconnectprovider.OpenidConnectProviderContract{
	// ...
}


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

Example Usage: OpenidConnectProviderClient.OpenIdConnectProviderDelete

ctx := context.TODO()
id := openidconnectprovider.NewOpenidConnectProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "opidValue")

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

Example Usage: OpenidConnectProviderClient.OpenIdConnectProviderGet

ctx := context.TODO()
id := openidconnectprovider.NewOpenidConnectProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "opidValue")

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

Example Usage: OpenidConnectProviderClient.OpenIdConnectProviderGetEntityTag

ctx := context.TODO()
id := openidconnectprovider.NewOpenidConnectProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "opidValue")

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

Example Usage: OpenidConnectProviderClient.OpenIdConnectProviderListByService

ctx := context.TODO()
id := openidconnectprovider.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")

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

Example Usage: OpenidConnectProviderClient.OpenIdConnectProviderListSecrets

ctx := context.TODO()
id := openidconnectprovider.NewOpenidConnectProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "opidValue")

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

Example Usage: OpenidConnectProviderClient.OpenIdConnectProviderUpdate

ctx := context.TODO()
id := openidconnectprovider.NewOpenidConnectProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "opidValue")

payload := openidconnectprovider.OpenidConnectProviderUpdateContract{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateOpenidConnectProviderID 

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

ValidateOpenidConnectProviderID checks that 'input' can be parsed as a Openid Connect Provider ID

func ValidateServiceID 

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

Types

type ClientSecretContract 

type ClientSecretContract struct {
	ClientSecret *string `json:"clientSecret,omitempty"`
}

type OpenIdConnectProviderCreateOrUpdateOperationOptions 

type OpenIdConnectProviderCreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultOpenIdConnectProviderCreateOrUpdateOperationOptions 

func DefaultOpenIdConnectProviderCreateOrUpdateOperationOptions() OpenIdConnectProviderCreateOrUpdateOperationOptions

type OpenIdConnectProviderCreateOrUpdateOperationResponse 

type OpenIdConnectProviderCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *OpenidConnectProviderContract
}

type OpenIdConnectProviderDeleteOperationOptions 

type OpenIdConnectProviderDeleteOperationOptions struct {
	IfMatch *string
}

func DefaultOpenIdConnectProviderDeleteOperationOptions 

func DefaultOpenIdConnectProviderDeleteOperationOptions() OpenIdConnectProviderDeleteOperationOptions

type OpenIdConnectProviderDeleteOperationResponse 

type OpenIdConnectProviderDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type OpenIdConnectProviderGetEntityTagOperationResponse 

type OpenIdConnectProviderGetEntityTagOperationResponse struct {
	HttpResponse *http.Response
}

type OpenIdConnectProviderGetOperationResponse 

type OpenIdConnectProviderGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *OpenidConnectProviderContract
}

type OpenIdConnectProviderListByServiceCompleteResult 

type OpenIdConnectProviderListByServiceCompleteResult struct {
	Items []OpenidConnectProviderContract
}

type OpenIdConnectProviderListByServiceOperationOptions 

type OpenIdConnectProviderListByServiceOperationOptions struct {
	Filter *string
	Skip   *int64
	Top    *int64
}

func DefaultOpenIdConnectProviderListByServiceOperationOptions 

func DefaultOpenIdConnectProviderListByServiceOperationOptions() OpenIdConnectProviderListByServiceOperationOptions

type OpenIdConnectProviderListByServiceOperationResponse 

type OpenIdConnectProviderListByServiceOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]OpenidConnectProviderContract
	// contains filtered or unexported fields
}

func (OpenIdConnectProviderListByServiceOperationResponse) HasMore 

func (r OpenIdConnectProviderListByServiceOperationResponse) HasMore() bool

func (OpenIdConnectProviderListByServiceOperationResponse) LoadMore 

func (r OpenIdConnectProviderListByServiceOperationResponse) LoadMore(ctx context.Context) (resp OpenIdConnectProviderListByServiceOperationResponse, err error)

type OpenIdConnectProviderListSecretsOperationResponse 

type OpenIdConnectProviderListSecretsOperationResponse struct {
	HttpResponse *http.Response
	Model        *ClientSecretContract
}

type OpenIdConnectProviderUpdateOperationOptions 

type OpenIdConnectProviderUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultOpenIdConnectProviderUpdateOperationOptions 

func DefaultOpenIdConnectProviderUpdateOperationOptions() OpenIdConnectProviderUpdateOperationOptions

type OpenIdConnectProviderUpdateOperationResponse 

type OpenIdConnectProviderUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *OpenidConnectProviderContract
}

type OpenidConnectProviderClient 

type OpenidConnectProviderClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewOpenidConnectProviderClientWithBaseURI 

func NewOpenidConnectProviderClientWithBaseURI(endpoint string) OpenidConnectProviderClient

func (OpenidConnectProviderClient) OpenIdConnectProviderCreateOrUpdate 

func (c OpenidConnectProviderClient) OpenIdConnectProviderCreateOrUpdate(ctx context.Context, id OpenidConnectProviderId, input OpenidConnectProviderContract, options OpenIdConnectProviderCreateOrUpdateOperationOptions) (result OpenIdConnectProviderCreateOrUpdateOperationResponse, err error)

OpenIdConnectProviderCreateOrUpdate ...

func (OpenidConnectProviderClient) OpenIdConnectProviderDelete 

func (c OpenidConnectProviderClient) OpenIdConnectProviderDelete(ctx context.Context, id OpenidConnectProviderId, options OpenIdConnectProviderDeleteOperationOptions) (result OpenIdConnectProviderDeleteOperationResponse, err error)

OpenIdConnectProviderDelete ...

func (OpenidConnectProviderClient) OpenIdConnectProviderGet 

func (c OpenidConnectProviderClient) OpenIdConnectProviderGet(ctx context.Context, id OpenidConnectProviderId) (result OpenIdConnectProviderGetOperationResponse, err error)

OpenIdConnectProviderGet ...

func (OpenidConnectProviderClient) OpenIdConnectProviderGetEntityTag 

func (c OpenidConnectProviderClient) OpenIdConnectProviderGetEntityTag(ctx context.Context, id OpenidConnectProviderId) (result OpenIdConnectProviderGetEntityTagOperationResponse, err error)

OpenIdConnectProviderGetEntityTag ...

func (OpenidConnectProviderClient) OpenIdConnectProviderListByService 

func (c OpenidConnectProviderClient) OpenIdConnectProviderListByService(ctx context.Context, id ServiceId, options OpenIdConnectProviderListByServiceOperationOptions) (resp OpenIdConnectProviderListByServiceOperationResponse, err error)

OpenIdConnectProviderListByService ...

func (OpenidConnectProviderClient) OpenIdConnectProviderListByServiceComplete 

func (c OpenidConnectProviderClient) OpenIdConnectProviderListByServiceComplete(ctx context.Context, id ServiceId, options OpenIdConnectProviderListByServiceOperationOptions) (OpenIdConnectProviderListByServiceCompleteResult, error)

OpenIdConnectProviderListByServiceComplete retrieves all of the results into a single object

func (OpenidConnectProviderClient) OpenIdConnectProviderListByServiceCompleteMatchingPredicate 

func (c OpenidConnectProviderClient) OpenIdConnectProviderListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options OpenIdConnectProviderListByServiceOperationOptions, predicate OpenidConnectProviderContractOperationPredicate) (resp OpenIdConnectProviderListByServiceCompleteResult, err error)

OpenIdConnectProviderListByServiceCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (OpenidConnectProviderClient) OpenIdConnectProviderListSecrets 

func (c OpenidConnectProviderClient) OpenIdConnectProviderListSecrets(ctx context.Context, id OpenidConnectProviderId) (result OpenIdConnectProviderListSecretsOperationResponse, err error)

OpenIdConnectProviderListSecrets ...

func (OpenidConnectProviderClient) OpenIdConnectProviderUpdate 

func (c OpenidConnectProviderClient) OpenIdConnectProviderUpdate(ctx context.Context, id OpenidConnectProviderId, input OpenidConnectProviderUpdateContract, options OpenIdConnectProviderUpdateOperationOptions) (result OpenIdConnectProviderUpdateOperationResponse, err error)

OpenIdConnectProviderUpdate ...

type OpenidConnectProviderContract 

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

type OpenidConnectProviderContractOperationPredicate 

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

func (OpenidConnectProviderContractOperationPredicate) Matches 

func (p OpenidConnectProviderContractOperationPredicate) Matches(input OpenidConnectProviderContract) bool

type OpenidConnectProviderContractProperties 

type OpenidConnectProviderContractProperties struct {
	ClientId         string  `json:"clientId"`
	ClientSecret     *string `json:"clientSecret,omitempty"`
	Description      *string `json:"description,omitempty"`
	DisplayName      string  `json:"displayName"`
	MetadataEndpoint string  `json:"metadataEndpoint"`
}

type OpenidConnectProviderId 

type OpenidConnectProviderId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	Opid              string
}

OpenidConnectProviderId is a struct representing the Resource ID for a Openid Connect Provider

func NewOpenidConnectProviderID 

func NewOpenidConnectProviderID(subscriptionId string, resourceGroupName string, serviceName string, opid string) OpenidConnectProviderId

NewOpenidConnectProviderID returns a new OpenidConnectProviderId struct

func ParseOpenidConnectProviderID 

func ParseOpenidConnectProviderID(input string) (*OpenidConnectProviderId, error)

ParseOpenidConnectProviderID parses 'input' into a OpenidConnectProviderId

func ParseOpenidConnectProviderIDInsensitively 

func ParseOpenidConnectProviderIDInsensitively(input string) (*OpenidConnectProviderId, error)

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

func (OpenidConnectProviderId) ID 

func (id OpenidConnectProviderId) ID() string

ID returns the formatted Openid Connect Provider ID

func (OpenidConnectProviderId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Openid Connect Provider ID

func (OpenidConnectProviderId) String 

func (id OpenidConnectProviderId) String() string

String returns a human-readable description of this Openid Connect Provider ID

type OpenidConnectProviderUpdateContract 

type OpenidConnectProviderUpdateContract struct {
	Properties *OpenidConnectProviderUpdateContractProperties `json:"properties,omitempty"`
}

type OpenidConnectProviderUpdateContractProperties 

type OpenidConnectProviderUpdateContractProperties struct {
	ClientId         *string `json:"clientId,omitempty"`
	ClientSecret     *string `json:"clientSecret,omitempty"`
	Description      *string `json:"description,omitempty"`
	DisplayName      *string `json:"displayName,omitempty"`
	MetadataEndpoint *string `json:"metadataEndpoint,omitempty"`
}

type ServiceId 

type ServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID 

func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID 

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively 

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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) ID 

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments 

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

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

func (ServiceId) String 

func (id ServiceId) String() string

String returns a human-readable description of this Service ID

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.