openidconnectprovider

package
v0.20230518.1140509 Latest Latest
Warning

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

Go to latest
Published: May 18, 2023 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.CreateOrUpdate

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

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


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

Example Usage: OpenidConnectProviderClient.Delete

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

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

Example Usage: OpenidConnectProviderClient.Get

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

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: OpenidConnectProviderClient.GetEntityTag

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

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: OpenidConnectProviderClient.ListByService

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

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

Example Usage: OpenidConnectProviderClient.ListSecrets

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

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: OpenidConnectProviderClient.Update

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

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


read, err := client.Update(ctx, id, payload, openidconnectprovider.DefaultUpdateOperationOptions())
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 CreateOrUpdateOperationOptions added in v0.20221024.1162143

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions added in v0.20221024.1162143

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

type CreateOrUpdateOperationResponse added in v0.20221024.1162143

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

type DeleteOperationOptions added in v0.20221024.1162143

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions added in v0.20221024.1162143

func DefaultDeleteOperationOptions() DeleteOperationOptions

type DeleteOperationResponse added in v0.20221024.1162143

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetEntityTagOperationResponse added in v0.20221024.1162143

type GetEntityTagOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationResponse added in v0.20221024.1162143

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

type ListByServiceCompleteResult added in v0.20221024.1162143

type ListByServiceCompleteResult struct {
	Items []OpenidConnectProviderContract
}

type ListByServiceOperationOptions added in v0.20221024.1162143

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

func DefaultListByServiceOperationOptions added in v0.20221024.1162143

func DefaultListByServiceOperationOptions() ListByServiceOperationOptions

type ListByServiceOperationResponse added in v0.20221024.1162143

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

func (ListByServiceOperationResponse) HasMore added in v0.20221024.1162143

func (ListByServiceOperationResponse) LoadMore added in v0.20221024.1162143

type ListSecretsOperationResponse added in v0.20221024.1162143

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

type OpenidConnectProviderClient

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

func NewOpenidConnectProviderClientWithBaseURI

func NewOpenidConnectProviderClientWithBaseURI(endpoint string) OpenidConnectProviderClient

func (OpenidConnectProviderClient) CreateOrUpdate added in v0.20221024.1162143

CreateOrUpdate ...

func (OpenidConnectProviderClient) Delete added in v0.20221024.1162143

Delete ...

func (OpenidConnectProviderClient) Get added in v0.20221024.1162143

Get ...

func (OpenidConnectProviderClient) GetEntityTag added in v0.20221024.1162143

GetEntityTag ...

func (OpenidConnectProviderClient) ListByService added in v0.20221024.1162143

ListByService ...

func (OpenidConnectProviderClient) ListByServiceComplete added in v0.20221024.1162143

ListByServiceComplete retrieves all of the results into a single object

func (OpenidConnectProviderClient) ListByServiceCompleteMatchingPredicate added in v0.20221024.1162143

ListByServiceCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (OpenidConnectProviderClient) ListSecrets added in v0.20221024.1162143

ListSecrets ...

func (OpenidConnectProviderClient) Update added in v0.20221024.1162143

Update ...

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

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
	OpenidConnectProviderName string
}

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

func NewOpenidConnectProviderID

func NewOpenidConnectProviderID(subscriptionId string, resourceGroupName string, serviceName string, openidConnectProviderName 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

ID returns the formatted Openid Connect Provider ID

func (OpenidConnectProviderId) Segments

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

type UpdateOperationOptions added in v0.20221024.1162143

type UpdateOperationOptions struct {
	IfMatch *string
}

func DefaultUpdateOperationOptions added in v0.20221024.1162143

func DefaultUpdateOperationOptions() UpdateOperationOptions

type UpdateOperationResponse added in v0.20221024.1162143

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL