namespaces

package
v0.20230208.1154850 Latest Latest
Warning

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

Go to latest
Published: Feb 8, 2023 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/servicebus/2021-06-01-preview/namespaces Documentation

The namespaces SDK allows for interaction with the Azure Resource Manager Service servicebus (API Version 2021-06-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/servicebus/2021-06-01-preview/namespaces"

Client Initialization

client := namespaces.NewNamespacesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NamespacesClient.CheckNameAvailability

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

payload := namespaces.CheckNameAvailability{
	// ...
}


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

Example Usage: NamespacesClient.CreateOrUpdate

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

payload := namespaces.SBNamespace{
	// ...
}


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

Example Usage: NamespacesClient.CreateOrUpdateNetworkRuleSet

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

payload := namespaces.NetworkRuleSet{
	// ...
}


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

Example Usage: NamespacesClient.Delete

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

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

Example Usage: NamespacesClient.Get

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

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: NamespacesClient.GetNetworkRuleSet

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

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

Example Usage: NamespacesClient.List

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

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

Example Usage: NamespacesClient.ListByResourceGroup

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

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

Example Usage: NamespacesClient.ListNetworkRuleSets

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

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

Example Usage: NamespacesClient.Update

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

payload := namespaces.SBNamespaceUpdateParameters{
	// ...
}


read, err := client.Update(ctx, id, payload)
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 PossibleValuesForDefaultAction

func PossibleValuesForDefaultAction() []string

func PossibleValuesForEndPointProvisioningState

func PossibleValuesForEndPointProvisioningState() []string

func PossibleValuesForKeySource

func PossibleValuesForKeySource() []string

func PossibleValuesForNetworkRuleIPAction

func PossibleValuesForNetworkRuleIPAction() []string

func PossibleValuesForPrivateLinkConnectionStatus

func PossibleValuesForPrivateLinkConnectionStatus() []string

func PossibleValuesForPublicNetworkAccessFlag

func PossibleValuesForPublicNetworkAccessFlag() []string

func PossibleValuesForSkuName

func PossibleValuesForSkuName() []string

func PossibleValuesForSkuTier

func PossibleValuesForSkuTier() []string

func PossibleValuesForUnavailableReason

func PossibleValuesForUnavailableReason() []string

func ValidateNamespaceID

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

ValidateNamespaceID checks that 'input' can be parsed as a Namespace ID

Types

type CheckNameAvailability

type CheckNameAvailability struct {
	Name string `json:"name"`
}

type CheckNameAvailabilityOperationResponse

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	Model        *CheckNameAvailabilityResult
}

type CheckNameAvailabilityResult

type CheckNameAvailabilityResult struct {
	Message       *string            `json:"message,omitempty"`
	NameAvailable *bool              `json:"nameAvailable,omitempty"`
	Reason        *UnavailableReason `json:"reason,omitempty"`
}

type ConnectionState

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

type CreateOrUpdateNetworkRuleSetOperationResponse

type CreateOrUpdateNetworkRuleSetOperationResponse struct {
	HttpResponse *http.Response
	Model        *NetworkRuleSet
}

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DefaultAction

type DefaultAction string
const (
	DefaultActionAllow DefaultAction = "Allow"
	DefaultActionDeny  DefaultAction = "Deny"
)

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type Encryption

type Encryption struct {
	KeySource                       *KeySource            `json:"keySource,omitempty"`
	KeyVaultProperties              *[]KeyVaultProperties `json:"keyVaultProperties,omitempty"`
	RequireInfrastructureEncryption *bool                 `json:"requireInfrastructureEncryption,omitempty"`
}

type EndPointProvisioningState

type EndPointProvisioningState string
const (
	EndPointProvisioningStateCanceled  EndPointProvisioningState = "Canceled"
	EndPointProvisioningStateCreating  EndPointProvisioningState = "Creating"
	EndPointProvisioningStateDeleting  EndPointProvisioningState = "Deleting"
	EndPointProvisioningStateFailed    EndPointProvisioningState = "Failed"
	EndPointProvisioningStateSucceeded EndPointProvisioningState = "Succeeded"
	EndPointProvisioningStateUpdating  EndPointProvisioningState = "Updating"
)

type GetNetworkRuleSetOperationResponse

type GetNetworkRuleSetOperationResponse struct {
	HttpResponse *http.Response
	Model        *NetworkRuleSet
}

type GetOperationResponse

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

type KeySource

type KeySource string
const (
	KeySourceMicrosoftPointKeyVault KeySource = "Microsoft.KeyVault"
)

type KeyVaultProperties

type KeyVaultProperties struct {
	Identity    *UserAssignedIdentityProperties `json:"identity,omitempty"`
	KeyName     *string                         `json:"keyName,omitempty"`
	KeyVaultUri *string                         `json:"keyVaultUri,omitempty"`
	KeyVersion  *string                         `json:"keyVersion,omitempty"`
}

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []SBNamespace
}

type ListByResourceGroupOperationResponse

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

func (ListByResourceGroupOperationResponse) HasMore

func (ListByResourceGroupOperationResponse) LoadMore

type ListCompleteResult

type ListCompleteResult struct {
	Items []SBNamespace
}

type ListNetworkRuleSetsCompleteResult

type ListNetworkRuleSetsCompleteResult struct {
	Items []NetworkRuleSet
}

type ListNetworkRuleSetsOperationResponse

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

func (ListNetworkRuleSetsOperationResponse) HasMore

func (ListNetworkRuleSetsOperationResponse) LoadMore

type ListOperationResponse

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

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

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

type NWRuleSetIPRules added in v0.20220725.1131927

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

type NWRuleSetVirtualNetworkRules

type NWRuleSetVirtualNetworkRules struct {
	IgnoreMissingVnetServiceEndpoint *bool   `json:"ignoreMissingVnetServiceEndpoint,omitempty"`
	Subnet                           *Subnet `json:"subnet,omitempty"`
}

type NamespaceId

type NamespaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
}

NamespaceId is a struct representing the Resource ID for a Namespace

func NewNamespaceID

func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId

NewNamespaceID returns a new NamespaceId struct

func ParseNamespaceID

func ParseNamespaceID(input string) (*NamespaceId, error)

ParseNamespaceID parses 'input' into a NamespaceId

func ParseNamespaceIDInsensitively

func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)

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

func (NamespaceId) ID

func (id NamespaceId) ID() string

ID returns the formatted Namespace ID

func (NamespaceId) Segments

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

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

func (NamespaceId) String

func (id NamespaceId) String() string

String returns a human-readable description of this Namespace ID

type NamespacesClient

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

func NewNamespacesClientWithBaseURI

func NewNamespacesClientWithBaseURI(endpoint string) NamespacesClient

func (NamespacesClient) CheckNameAvailability

CheckNameAvailability ...

func (NamespacesClient) CreateOrUpdate

func (c NamespacesClient) CreateOrUpdate(ctx context.Context, id NamespaceId, input SBNamespace) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (NamespacesClient) CreateOrUpdateNetworkRuleSet

func (c NamespacesClient) CreateOrUpdateNetworkRuleSet(ctx context.Context, id NamespaceId, input NetworkRuleSet) (result CreateOrUpdateNetworkRuleSetOperationResponse, err error)

CreateOrUpdateNetworkRuleSet ...

func (NamespacesClient) CreateOrUpdateThenPoll

func (c NamespacesClient) CreateOrUpdateThenPoll(ctx context.Context, id NamespaceId, input SBNamespace) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (NamespacesClient) Delete

func (c NamespacesClient) Delete(ctx context.Context, id NamespaceId) (result DeleteOperationResponse, err error)

Delete ...

func (NamespacesClient) DeleteThenPoll

func (c NamespacesClient) DeleteThenPoll(ctx context.Context, id NamespaceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (NamespacesClient) Get

Get ...

func (NamespacesClient) GetNetworkRuleSet

func (c NamespacesClient) GetNetworkRuleSet(ctx context.Context, id NamespaceId) (result GetNetworkRuleSetOperationResponse, err error)

GetNetworkRuleSet ...

func (NamespacesClient) List

List ...

func (NamespacesClient) ListByResourceGroup

ListByResourceGroup ...

func (NamespacesClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all of the results into a single object

func (NamespacesClient) ListByResourceGroupCompleteMatchingPredicate

func (c NamespacesClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate SBNamespaceOperationPredicate) (resp ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (NamespacesClient) ListComplete

ListComplete retrieves all of the results into a single object

func (NamespacesClient) ListCompleteMatchingPredicate

func (c NamespacesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate SBNamespaceOperationPredicate) (resp ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (NamespacesClient) ListNetworkRuleSets

func (c NamespacesClient) ListNetworkRuleSets(ctx context.Context, id NamespaceId) (resp ListNetworkRuleSetsOperationResponse, err error)

ListNetworkRuleSets ...

func (NamespacesClient) ListNetworkRuleSetsComplete

func (c NamespacesClient) ListNetworkRuleSetsComplete(ctx context.Context, id NamespaceId) (ListNetworkRuleSetsCompleteResult, error)

ListNetworkRuleSetsComplete retrieves all of the results into a single object

func (NamespacesClient) ListNetworkRuleSetsCompleteMatchingPredicate

func (c NamespacesClient) ListNetworkRuleSetsCompleteMatchingPredicate(ctx context.Context, id NamespaceId, predicate NetworkRuleSetOperationPredicate) (resp ListNetworkRuleSetsCompleteResult, err error)

ListNetworkRuleSetsCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (NamespacesClient) Update

Update ...

type NetworkRuleIPAction

type NetworkRuleIPAction string
const (
	NetworkRuleIPActionAllow NetworkRuleIPAction = "Allow"
)

type NetworkRuleSet

type NetworkRuleSet struct {
	Id         *string                   `json:"id,omitempty"`
	Name       *string                   `json:"name,omitempty"`
	Properties *NetworkRuleSetProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData    `json:"systemData,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type NetworkRuleSetOperationPredicate

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

func (NetworkRuleSetOperationPredicate) Matches

type NetworkRuleSetProperties

type NetworkRuleSetProperties struct {
	DefaultAction               *DefaultAction                  `json:"defaultAction,omitempty"`
	IPRules                     *[]NWRuleSetIPRules             `json:"ipRules,omitempty"`
	PublicNetworkAccess         *PublicNetworkAccessFlag        `json:"publicNetworkAccess,omitempty"`
	TrustedServiceAccessEnabled *bool                           `json:"trustedServiceAccessEnabled,omitempty"`
	VirtualNetworkRules         *[]NWRuleSetVirtualNetworkRules `json:"virtualNetworkRules,omitempty"`
}

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"`
	SystemData *systemdata.SystemData               `json:"systemData,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	PrivateEndpoint                   *PrivateEndpoint           `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *ConnectionState           `json:"privateLinkServiceConnectionState,omitempty"`
	ProvisioningState                 *EndPointProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateLinkConnectionStatus

type PrivateLinkConnectionStatus string
const (
	PrivateLinkConnectionStatusApproved     PrivateLinkConnectionStatus = "Approved"
	PrivateLinkConnectionStatusDisconnected PrivateLinkConnectionStatus = "Disconnected"
	PrivateLinkConnectionStatusPending      PrivateLinkConnectionStatus = "Pending"
	PrivateLinkConnectionStatusRejected     PrivateLinkConnectionStatus = "Rejected"
)

type PublicNetworkAccessFlag

type PublicNetworkAccessFlag string
const (
	PublicNetworkAccessFlagDisabled PublicNetworkAccessFlag = "Disabled"
	PublicNetworkAccessFlagEnabled  PublicNetworkAccessFlag = "Enabled"
)

type SBNamespace

type SBNamespace struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                             `json:"location"`
	Name       *string                            `json:"name,omitempty"`
	Properties *SBNamespaceProperties             `json:"properties,omitempty"`
	Sku        *SBSku                             `json:"sku,omitempty"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type SBNamespaceOperationPredicate

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

func (SBNamespaceOperationPredicate) Matches

type SBNamespaceProperties

type SBNamespaceProperties struct {
	CreatedAt                  *string                      `json:"createdAt,omitempty"`
	DisableLocalAuth           *bool                        `json:"disableLocalAuth,omitempty"`
	Encryption                 *Encryption                  `json:"encryption,omitempty"`
	MetricId                   *string                      `json:"metricId,omitempty"`
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	ProvisioningState          *string                      `json:"provisioningState,omitempty"`
	ServiceBusEndpoint         *string                      `json:"serviceBusEndpoint,omitempty"`
	Status                     *string                      `json:"status,omitempty"`
	UpdatedAt                  *string                      `json:"updatedAt,omitempty"`
	ZoneRedundant              *bool                        `json:"zoneRedundant,omitempty"`
}

func (*SBNamespaceProperties) GetCreatedAtAsTime

func (o *SBNamespaceProperties) GetCreatedAtAsTime() (*time.Time, error)

func (*SBNamespaceProperties) GetUpdatedAtAsTime

func (o *SBNamespaceProperties) GetUpdatedAtAsTime() (*time.Time, error)

func (*SBNamespaceProperties) SetCreatedAtAsTime

func (o *SBNamespaceProperties) SetCreatedAtAsTime(input time.Time)

func (*SBNamespaceProperties) SetUpdatedAtAsTime

func (o *SBNamespaceProperties) SetUpdatedAtAsTime(input time.Time)

type SBNamespaceUpdateParameters

type SBNamespaceUpdateParameters struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *SBNamespaceProperties             `json:"properties,omitempty"`
	Sku        *SBSku                             `json:"sku,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type SBSku

type SBSku struct {
	Capacity *int64   `json:"capacity,omitempty"`
	Name     SkuName  `json:"name"`
	Tier     *SkuTier `json:"tier,omitempty"`
}

type SkuName

type SkuName string
const (
	SkuNameBasic    SkuName = "Basic"
	SkuNamePremium  SkuName = "Premium"
	SkuNameStandard SkuName = "Standard"
)

type SkuTier

type SkuTier string
const (
	SkuTierBasic    SkuTier = "Basic"
	SkuTierPremium  SkuTier = "Premium"
	SkuTierStandard SkuTier = "Standard"
)

type Subnet

type Subnet struct {
	Id string `json:"id"`
}

type UnavailableReason

type UnavailableReason string
const (
	UnavailableReasonInvalidName                           UnavailableReason = "InvalidName"
	UnavailableReasonNameInLockdown                        UnavailableReason = "NameInLockdown"
	UnavailableReasonNameInUse                             UnavailableReason = "NameInUse"
	UnavailableReasonNone                                  UnavailableReason = "None"
	UnavailableReasonSubscriptionIsDisabled                UnavailableReason = "SubscriptionIsDisabled"
	UnavailableReasonTooManyNamespaceInCurrentSubscription UnavailableReason = "TooManyNamespaceInCurrentSubscription"
)

type UpdateOperationResponse

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

type UserAssignedIdentityProperties

type UserAssignedIdentityProperties struct {
	UserAssignedIdentity *string `json:"userAssignedIdentity,omitempty"`
}

Jump to

Keyboard shortcuts

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