partnernamespaces

package
v0.20240221.1115631 Latest Latest
Warning

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

Go to latest
Published: Feb 21, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2022-06-15/partnernamespaces Documentation

The partnernamespaces SDK allows for interaction with the Azure Resource Manager Service eventgrid (API Version 2022-06-15).

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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2022-06-15/partnernamespaces"

Client Initialization

client := partnernamespaces.NewPartnerNamespacesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PartnerNamespacesClient.CreateOrUpdate

ctx := context.TODO()
id := partnernamespaces.NewPartnerNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerNamespaceValue")

payload := partnernamespaces.PartnerNamespace{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: PartnerNamespacesClient.Delete

ctx := context.TODO()
id := partnernamespaces.NewPartnerNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerNamespaceValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: PartnerNamespacesClient.Get

ctx := context.TODO()
id := partnernamespaces.NewPartnerNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerNamespaceValue")

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: PartnerNamespacesClient.ListByResourceGroup

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

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

Example Usage: PartnerNamespacesClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: PartnerNamespacesClient.ListSharedAccessKeys

ctx := context.TODO()
id := partnernamespaces.NewPartnerNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerNamespaceValue")

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

Example Usage: PartnerNamespacesClient.RegenerateKey

ctx := context.TODO()
id := partnernamespaces.NewPartnerNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerNamespaceValue")

payload := partnernamespaces.PartnerNamespaceRegenerateKeyRequest{
	// ...
}


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

Example Usage: PartnerNamespacesClient.Update

ctx := context.TODO()
id := partnernamespaces.NewPartnerNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerNamespaceValue")

payload := partnernamespaces.PartnerNamespaceUpdateParameters{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForIPActionType

func PossibleValuesForIPActionType() []string

func PossibleValuesForPartnerNamespaceProvisioningState

func PossibleValuesForPartnerNamespaceProvisioningState() []string

func PossibleValuesForPartnerTopicRoutingMode

func PossibleValuesForPartnerTopicRoutingMode() []string

func PossibleValuesForPersistedConnectionStatus

func PossibleValuesForPersistedConnectionStatus() []string

func PossibleValuesForPublicNetworkAccess

func PossibleValuesForPublicNetworkAccess() []string

func PossibleValuesForResourceProvisioningState

func PossibleValuesForResourceProvisioningState() []string

func ValidatePartnerNamespaceID

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

ValidatePartnerNamespaceID checks that 'input' can be parsed as a Partner Namespace ID

Types

type ConnectionState

type ConnectionState struct {
	ActionsRequired *string                    `json:"actionsRequired,omitempty"`
	Description     *string                    `json:"description,omitempty"`
	Status          *PersistedConnectionStatus `json:"status,omitempty"`
}

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerNamespace
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerNamespace
}

type IPActionType

type IPActionType string
const (
	IPActionTypeAllow IPActionType = "Allow"
)

func (*IPActionType) UnmarshalJSON

func (s *IPActionType) UnmarshalJSON(bytes []byte) error

type InboundIPRule

type InboundIPRule struct {
	Action *IPActionType `json:"action,omitempty"`
	IPMask *string       `json:"ipMask,omitempty"`
}

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PartnerNamespace
}

type ListByResourceGroupOperationOptions

type ListByResourceGroupOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListByResourceGroupOperationOptions

func DefaultListByResourceGroupOperationOptions() ListByResourceGroupOperationOptions

func (ListByResourceGroupOperationOptions) ToHeaders

func (ListByResourceGroupOperationOptions) ToOData

func (ListByResourceGroupOperationOptions) ToQuery

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PartnerNamespace
}

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PartnerNamespace
}

type ListBySubscriptionOperationOptions

type ListBySubscriptionOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListBySubscriptionOperationOptions

func DefaultListBySubscriptionOperationOptions() ListBySubscriptionOperationOptions

func (ListBySubscriptionOperationOptions) ToHeaders

func (ListBySubscriptionOperationOptions) ToOData

func (ListBySubscriptionOperationOptions) ToQuery

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PartnerNamespace
}

type ListSharedAccessKeysOperationResponse

type ListSharedAccessKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerNamespaceSharedAccessKeys
}

type PartnerNamespace

type PartnerNamespace struct {
	Id         *string                     `json:"id,omitempty"`
	Location   string                      `json:"location"`
	Name       *string                     `json:"name,omitempty"`
	Properties *PartnerNamespaceProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Tags       *map[string]string          `json:"tags,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type PartnerNamespaceId

type PartnerNamespaceId struct {
	SubscriptionId       string
	ResourceGroupName    string
	PartnerNamespaceName string
}

PartnerNamespaceId is a struct representing the Resource ID for a Partner Namespace

func NewPartnerNamespaceID

func NewPartnerNamespaceID(subscriptionId string, resourceGroupName string, partnerNamespaceName string) PartnerNamespaceId

NewPartnerNamespaceID returns a new PartnerNamespaceId struct

func ParsePartnerNamespaceID

func ParsePartnerNamespaceID(input string) (*PartnerNamespaceId, error)

ParsePartnerNamespaceID parses 'input' into a PartnerNamespaceId

func ParsePartnerNamespaceIDInsensitively

func ParsePartnerNamespaceIDInsensitively(input string) (*PartnerNamespaceId, error)

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

func (*PartnerNamespaceId) FromParseResult

func (id *PartnerNamespaceId) FromParseResult(input resourceids.ParseResult) error

func (PartnerNamespaceId) ID

func (id PartnerNamespaceId) ID() string

ID returns the formatted Partner Namespace ID

func (PartnerNamespaceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Partner Namespace ID

func (PartnerNamespaceId) String

func (id PartnerNamespaceId) String() string

String returns a human-readable description of this Partner Namespace ID

type PartnerNamespaceOperationPredicate

type PartnerNamespaceOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (PartnerNamespaceOperationPredicate) Matches

type PartnerNamespaceProperties

type PartnerNamespaceProperties struct {
	DisableLocalAuth                    *bool                              `json:"disableLocalAuth,omitempty"`
	Endpoint                            *string                            `json:"endpoint,omitempty"`
	InboundIPRules                      *[]InboundIPRule                   `json:"inboundIpRules,omitempty"`
	PartnerRegistrationFullyQualifiedId *string                            `json:"partnerRegistrationFullyQualifiedId,omitempty"`
	PartnerTopicRoutingMode             *PartnerTopicRoutingMode           `json:"partnerTopicRoutingMode,omitempty"`
	PrivateEndpointConnections          *[]PrivateEndpointConnection       `json:"privateEndpointConnections,omitempty"`
	ProvisioningState                   *PartnerNamespaceProvisioningState `json:"provisioningState,omitempty"`
	PublicNetworkAccess                 *PublicNetworkAccess               `json:"publicNetworkAccess,omitempty"`
}

type PartnerNamespaceProvisioningState

type PartnerNamespaceProvisioningState string
const (
	PartnerNamespaceProvisioningStateCanceled  PartnerNamespaceProvisioningState = "Canceled"
	PartnerNamespaceProvisioningStateCreating  PartnerNamespaceProvisioningState = "Creating"
	PartnerNamespaceProvisioningStateDeleting  PartnerNamespaceProvisioningState = "Deleting"
	PartnerNamespaceProvisioningStateFailed    PartnerNamespaceProvisioningState = "Failed"
	PartnerNamespaceProvisioningStateSucceeded PartnerNamespaceProvisioningState = "Succeeded"
	PartnerNamespaceProvisioningStateUpdating  PartnerNamespaceProvisioningState = "Updating"
)

func (*PartnerNamespaceProvisioningState) UnmarshalJSON

func (s *PartnerNamespaceProvisioningState) UnmarshalJSON(bytes []byte) error

type PartnerNamespaceRegenerateKeyRequest

type PartnerNamespaceRegenerateKeyRequest struct {
	KeyName string `json:"keyName"`
}

type PartnerNamespaceSharedAccessKeys

type PartnerNamespaceSharedAccessKeys struct {
	Key1 *string `json:"key1,omitempty"`
	Key2 *string `json:"key2,omitempty"`
}

type PartnerNamespaceUpdateParameterProperties

type PartnerNamespaceUpdateParameterProperties struct {
	DisableLocalAuth    *bool                `json:"disableLocalAuth,omitempty"`
	InboundIPRules      *[]InboundIPRule     `json:"inboundIpRules,omitempty"`
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
}

type PartnerNamespaceUpdateParameters

type PartnerNamespaceUpdateParameters struct {
	Properties *PartnerNamespaceUpdateParameterProperties `json:"properties,omitempty"`
	Tags       *map[string]string                         `json:"tags,omitempty"`
}

type PartnerNamespacesClient

type PartnerNamespacesClient struct {
	Client *resourcemanager.Client
}

func NewPartnerNamespacesClientWithBaseURI

func NewPartnerNamespacesClientWithBaseURI(sdkApi sdkEnv.Api) (*PartnerNamespacesClient, error)

func (PartnerNamespacesClient) CreateOrUpdate

CreateOrUpdate ...

func (PartnerNamespacesClient) CreateOrUpdateThenPoll

func (c PartnerNamespacesClient) CreateOrUpdateThenPoll(ctx context.Context, id PartnerNamespaceId, input PartnerNamespace) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (PartnerNamespacesClient) Delete

Delete ...

func (PartnerNamespacesClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (PartnerNamespacesClient) Get

Get ...

func (PartnerNamespacesClient) ListByResourceGroup

ListByResourceGroup ...

func (PartnerNamespacesClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (PartnerNamespacesClient) ListByResourceGroupCompleteMatchingPredicate

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PartnerNamespacesClient) ListBySubscription

ListBySubscription ...

func (PartnerNamespacesClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (PartnerNamespacesClient) ListBySubscriptionCompleteMatchingPredicate

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PartnerNamespacesClient) ListSharedAccessKeys

ListSharedAccessKeys ...

func (PartnerNamespacesClient) RegenerateKey

RegenerateKey ...

func (PartnerNamespacesClient) Update

Update ...

func (PartnerNamespacesClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type PartnerTopicRoutingMode

type PartnerTopicRoutingMode string
const (
	PartnerTopicRoutingModeChannelNameHeader    PartnerTopicRoutingMode = "ChannelNameHeader"
	PartnerTopicRoutingModeSourceEventAttribute PartnerTopicRoutingMode = "SourceEventAttribute"
)

func (*PartnerTopicRoutingMode) UnmarshalJSON

func (s *PartnerTopicRoutingMode) UnmarshalJSON(bytes []byte) error

type PersistedConnectionStatus

type PersistedConnectionStatus string
const (
	PersistedConnectionStatusApproved     PersistedConnectionStatus = "Approved"
	PersistedConnectionStatusDisconnected PersistedConnectionStatus = "Disconnected"
	PersistedConnectionStatusPending      PersistedConnectionStatus = "Pending"
	PersistedConnectionStatusRejected     PersistedConnectionStatus = "Rejected"
)

func (*PersistedConnectionStatus) UnmarshalJSON

func (s *PersistedConnectionStatus) UnmarshalJSON(bytes []byte) error

type PrivateEndpoint

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnection

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

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	GroupIds                          *[]string                  `json:"groupIds,omitempty"`
	PrivateEndpoint                   *PrivateEndpoint           `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *ConnectionState           `json:"privateLinkServiceConnectionState,omitempty"`
	ProvisioningState                 *ResourceProvisioningState `json:"provisioningState,omitempty"`
}

type PublicNetworkAccess

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func (*PublicNetworkAccess) UnmarshalJSON

func (s *PublicNetworkAccess) UnmarshalJSON(bytes []byte) error

type RegenerateKeyOperationResponse

type RegenerateKeyOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerNamespaceSharedAccessKeys
}

type ResourceProvisioningState

type ResourceProvisioningState string
const (
	ResourceProvisioningStateCanceled  ResourceProvisioningState = "Canceled"
	ResourceProvisioningStateCreating  ResourceProvisioningState = "Creating"
	ResourceProvisioningStateDeleting  ResourceProvisioningState = "Deleting"
	ResourceProvisioningStateFailed    ResourceProvisioningState = "Failed"
	ResourceProvisioningStateSucceeded ResourceProvisioningState = "Succeeded"
	ResourceProvisioningStateUpdating  ResourceProvisioningState = "Updating"
)

func (*ResourceProvisioningState) UnmarshalJSON

func (s *ResourceProvisioningState) UnmarshalJSON(bytes []byte) error

type UpdateOperationResponse

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerNamespace
}

Jump to

Keyboard shortcuts

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