namespaces

package
v0.20221010.1154133 Latest Latest
Warning

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

 Go to latest Published: Oct 10, 2022 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/relay/2017-04-01/namespaces Documentation

The namespaces SDK allows for interaction with the Azure Resource Manager Service relay (API Version 2017-04-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/relay/2017-04-01/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.RelayNamespace{
	// ...
}


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

Example Usage: NamespacesClient.CreateOrUpdateAuthorizationRule

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

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


read, err := client.CreateOrUpdateAuthorizationRule(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.DeleteAuthorizationRule

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

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

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.GetAuthorizationRule

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

read, err := client.GetAuthorizationRule(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.ListAuthorizationRules

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

// alternatively `client.ListAuthorizationRules(ctx, id)` can be used to do batched pagination
items, err := client.ListAuthorizationRulesComplete(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.ListKeys

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

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

Example Usage: NamespacesClient.RegenerateKeys

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

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


read, err := client.RegenerateKeys(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.Update

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

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


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 PossibleValuesForAccessRights 

func PossibleValuesForAccessRights() []string

func PossibleValuesForKeyType 

func PossibleValuesForKeyType() []string

func PossibleValuesForProvisioningStateEnum 

func PossibleValuesForProvisioningStateEnum() []string

func PossibleValuesForSkuName 

func PossibleValuesForSkuName() []string

func PossibleValuesForSkuTier 

func PossibleValuesForSkuTier() []string

func PossibleValuesForUnavailableReason 

func PossibleValuesForUnavailableReason() []string

func ValidateAuthorizationRuleID 

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

ValidateAuthorizationRuleID checks that 'input' can be parsed as a Authorization Rule ID

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 AccessKeys 

type AccessKeys struct {
	KeyName                   *string `json:"keyName,omitempty"`
	PrimaryConnectionString   *string `json:"primaryConnectionString,omitempty"`
	PrimaryKey                *string `json:"primaryKey,omitempty"`
	SecondaryConnectionString *string `json:"secondaryConnectionString,omitempty"`
	SecondaryKey              *string `json:"secondaryKey,omitempty"`
}

type AccessRights 

type AccessRights string
const (
	AccessRightsListen AccessRights = "Listen"
	AccessRightsManage AccessRights = "Manage"
	AccessRightsSend   AccessRights = "Send"
)

type AuthorizationRule 

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

type AuthorizationRuleId 

type AuthorizationRuleId struct {
	SubscriptionId        string
	ResourceGroupName     string
	NamespaceName         string
	AuthorizationRuleName string
}

AuthorizationRuleId is a struct representing the Resource ID for a Authorization Rule

func NewAuthorizationRuleID 

func NewAuthorizationRuleID(subscriptionId string, resourceGroupName string, namespaceName string, authorizationRuleName string) AuthorizationRuleId

NewAuthorizationRuleID returns a new AuthorizationRuleId struct

func ParseAuthorizationRuleID 

func ParseAuthorizationRuleID(input string) (*AuthorizationRuleId, error)

ParseAuthorizationRuleID parses 'input' into a AuthorizationRuleId

func ParseAuthorizationRuleIDInsensitively 

func ParseAuthorizationRuleIDInsensitively(input string) (*AuthorizationRuleId, error)

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

func (AuthorizationRuleId) ID 

func (id AuthorizationRuleId) ID() string

ID returns the formatted Authorization Rule ID

func (AuthorizationRuleId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Authorization Rule ID

func (AuthorizationRuleId) String 

func (id AuthorizationRuleId) String() string

String returns a human-readable description of this Authorization Rule ID

type AuthorizationRuleOperationPredicate 

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

func (AuthorizationRuleOperationPredicate) Matches 

func (p AuthorizationRuleOperationPredicate) Matches(input AuthorizationRule) bool

type AuthorizationRuleProperties 

type AuthorizationRuleProperties struct {
	Rights []AccessRights `json:"rights"`
}

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 CreateOrUpdateAuthorizationRuleOperationResponse 

type CreateOrUpdateAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
	Model        *AuthorizationRule
}

type CreateOrUpdateOperationResponse 

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

type DeleteAuthorizationRuleOperationResponse 

type DeleteAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
}

type DeleteOperationResponse 

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

type GetAuthorizationRuleOperationResponse 

type GetAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
	Model        *AuthorizationRule
}

type GetOperationResponse 

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

type KeyType 

type KeyType string
const (
	KeyTypePrimaryKey   KeyType = "PrimaryKey"
	KeyTypeSecondaryKey KeyType = "SecondaryKey"
)

type ListAuthorizationRulesCompleteResult 

type ListAuthorizationRulesCompleteResult struct {
	Items []AuthorizationRule
}

type ListAuthorizationRulesOperationResponse 

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

func (ListAuthorizationRulesOperationResponse) HasMore 

func (r ListAuthorizationRulesOperationResponse) HasMore() bool

func (ListAuthorizationRulesOperationResponse) LoadMore 

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

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	Items []RelayNamespace
}

type ListByResourceGroupOperationResponse 

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

func (ListByResourceGroupOperationResponse) HasMore 

func (r ListByResourceGroupOperationResponse) HasMore() bool

func (ListByResourceGroupOperationResponse) LoadMore 

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

type ListCompleteResult 

type ListCompleteResult struct {
	Items []RelayNamespace
}

type ListKeysOperationResponse 

type ListKeysOperationResponse struct {
	HttpResponse *http.Response
	Model        *AccessKeys
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]RelayNamespace
	// 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 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 

func (c NamespacesClient) CheckNameAvailability(ctx context.Context, id commonids.SubscriptionId, input CheckNameAvailability) (result CheckNameAvailabilityOperationResponse, err error)

CheckNameAvailability ...

func (NamespacesClient) CreateOrUpdate 

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

CreateOrUpdate ...

func (NamespacesClient) CreateOrUpdateAuthorizationRule 

func (c NamespacesClient) CreateOrUpdateAuthorizationRule(ctx context.Context, id AuthorizationRuleId, input AuthorizationRule) (result CreateOrUpdateAuthorizationRuleOperationResponse, err error)

CreateOrUpdateAuthorizationRule ...

func (NamespacesClient) CreateOrUpdateThenPoll 

func (c NamespacesClient) CreateOrUpdateThenPoll(ctx context.Context, id NamespaceId, input RelayNamespace) 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) DeleteAuthorizationRule 

func (c NamespacesClient) DeleteAuthorizationRule(ctx context.Context, id AuthorizationRuleId) (result DeleteAuthorizationRuleOperationResponse, err error)

DeleteAuthorizationRule ...

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 

func (c NamespacesClient) Get(ctx context.Context, id NamespaceId) (result GetOperationResponse, err error)

Get ...

func (NamespacesClient) GetAuthorizationRule 

func (c NamespacesClient) GetAuthorizationRule(ctx context.Context, id AuthorizationRuleId) (result GetAuthorizationRuleOperationResponse, err error)

GetAuthorizationRule ...

func (NamespacesClient) List 

func (c NamespacesClient) List(ctx context.Context, id commonids.SubscriptionId) (resp ListOperationResponse, err error)

List ...

func (NamespacesClient) ListAuthorizationRules 

func (c NamespacesClient) ListAuthorizationRules(ctx context.Context, id NamespaceId) (resp ListAuthorizationRulesOperationResponse, err error)

ListAuthorizationRules ...

func (NamespacesClient) ListAuthorizationRulesComplete 

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

ListAuthorizationRulesComplete retrieves all of the results into a single object

func (NamespacesClient) ListAuthorizationRulesCompleteMatchingPredicate 

func (c NamespacesClient) ListAuthorizationRulesCompleteMatchingPredicate(ctx context.Context, id NamespaceId, predicate AuthorizationRuleOperationPredicate) (resp ListAuthorizationRulesCompleteResult, err error)

ListAuthorizationRulesCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (NamespacesClient) ListByResourceGroup 

func (c NamespacesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (resp ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (NamespacesClient) ListByResourceGroupComplete 

func (c NamespacesClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all of the results into a single object

func (NamespacesClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (NamespacesClient) ListComplete 

func (c NamespacesClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all of the results into a single object

func (NamespacesClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (NamespacesClient) ListKeys 

func (c NamespacesClient) ListKeys(ctx context.Context, id AuthorizationRuleId) (result ListKeysOperationResponse, err error)

ListKeys ...

func (NamespacesClient) RegenerateKeys 

func (c NamespacesClient) RegenerateKeys(ctx context.Context, id AuthorizationRuleId, input RegenerateAccessKeyParameters) (result RegenerateKeysOperationResponse, err error)

RegenerateKeys ...

func (NamespacesClient) Update 

func (c NamespacesClient) Update(ctx context.Context, id NamespaceId, input RelayUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

type ProvisioningStateEnum 

type ProvisioningStateEnum string
const (
	ProvisioningStateEnumCreated   ProvisioningStateEnum = "Created"
	ProvisioningStateEnumDeleted   ProvisioningStateEnum = "Deleted"
	ProvisioningStateEnumFailed    ProvisioningStateEnum = "Failed"
	ProvisioningStateEnumSucceeded ProvisioningStateEnum = "Succeeded"
	ProvisioningStateEnumUnknown   ProvisioningStateEnum = "Unknown"
	ProvisioningStateEnumUpdating  ProvisioningStateEnum = "Updating"
)

type RegenerateAccessKeyParameters 

type RegenerateAccessKeyParameters struct {
	Key     *string `json:"key,omitempty"`
	KeyType KeyType `json:"keyType"`
}

type RegenerateKeysOperationResponse 

type RegenerateKeysOperationResponse struct {
	HttpResponse *http.Response
	Model        *AccessKeys
}

type RelayNamespace 

type RelayNamespace struct {
	Id         *string                   `json:"id,omitempty"`
	Location   string                    `json:"location"`
	Name       *string                   `json:"name,omitempty"`
	Properties *RelayNamespaceProperties `json:"properties,omitempty"`
	Sku        *Sku                      `json:"sku,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type RelayNamespaceOperationPredicate 

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

func (RelayNamespaceOperationPredicate) Matches 

func (p RelayNamespaceOperationPredicate) Matches(input RelayNamespace) bool

type RelayNamespaceProperties 

type RelayNamespaceProperties struct {
	CreatedAt          *string                `json:"createdAt,omitempty"`
	MetricId           *string                `json:"metricId,omitempty"`
	ProvisioningState  *ProvisioningStateEnum `json:"provisioningState,omitempty"`
	ServiceBusEndpoint *string                `json:"serviceBusEndpoint,omitempty"`
	UpdatedAt          *string                `json:"updatedAt,omitempty"`
}

func (*RelayNamespaceProperties) GetCreatedAtAsTime 

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

func (*RelayNamespaceProperties) GetUpdatedAtAsTime 

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

func (*RelayNamespaceProperties) SetCreatedAtAsTime 

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

func (*RelayNamespaceProperties) SetUpdatedAtAsTime 

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

type RelayUpdateParameters 

type RelayUpdateParameters struct {
	Id         *string                   `json:"id,omitempty"`
	Name       *string                   `json:"name,omitempty"`
	Properties *RelayNamespaceProperties `json:"properties,omitempty"`
	Sku        *Sku                      `json:"sku,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type Sku 

type Sku struct {
	Name SkuName  `json:"name"`
	Tier *SkuTier `json:"tier,omitempty"`
}

type SkuName 

type SkuName string
const (
	SkuNameStandard SkuName = "Standard"
)

type SkuTier 

type SkuTier string
const (
	SkuTierStandard SkuTier = "Standard"
)

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        *RelayNamespace
}

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.