namespaces

package
v0.20240527.1094340 Latest Latest
Warning

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

Go to latest
Published: May 27, 2024 License: MPL-2.0 Imports: 15 Imported by: 3

README

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

The namespaces SDK allows for interaction with the Azure Resource Manager Service notificationhubs (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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/notificationhubs/2017-04-01/namespaces"

Client Initialization

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

Example Usage: NamespacesClient.CheckAvailability

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

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


read, err := client.CheckAvailability(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.NamespaceCreateOrUpdateParameters{
	// ...
}


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

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

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


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 := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

// 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.ListAll

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

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

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

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


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

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

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


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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAccessRights

func PossibleValuesForAccessRights() []string

func PossibleValuesForNamespaceType

func PossibleValuesForNamespaceType() []string

func PossibleValuesForSkuName

func PossibleValuesForSkuName() []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 AccessRights

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

func (*AccessRights) UnmarshalJSON

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

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

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

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 CheckAvailabilityOperationResponse

type CheckAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckAvailabilityResult
}

type CheckAvailabilityParameters

type CheckAvailabilityParameters struct {
	Id           *string            `json:"id,omitempty"`
	IsAvailiable *bool              `json:"isAvailiable,omitempty"`
	Location     *string            `json:"location,omitempty"`
	Name         string             `json:"name"`
	Sku          *Sku               `json:"sku,omitempty"`
	Tags         *map[string]string `json:"tags,omitempty"`
	Type         *string            `json:"type,omitempty"`
}

type CheckAvailabilityResult

type CheckAvailabilityResult struct {
	Id           *string            `json:"id,omitempty"`
	IsAvailiable *bool              `json:"isAvailiable,omitempty"`
	Location     *string            `json:"location,omitempty"`
	Name         *string            `json:"name,omitempty"`
	Sku          *Sku               `json:"sku,omitempty"`
	Tags         *map[string]string `json:"tags,omitempty"`
	Type         *string            `json:"type,omitempty"`
}

type CreateOrUpdateAuthorizationRuleOperationResponse

type CreateOrUpdateAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SharedAccessAuthorizationRuleResource
}

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NamespaceResource
}

type DeleteAuthorizationRuleOperationResponse

type DeleteAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeleteOperationResponse

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

type GetAuthorizationRuleOperationResponse

type GetAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SharedAccessAuthorizationRuleResource
}

type GetOperationResponse

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

type ListAllCompleteResult

type ListAllCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NamespaceResource
}

type ListAllOperationResponse

type ListAllOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NamespaceResource
}

type ListAuthorizationRulesCompleteResult

type ListAuthorizationRulesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SharedAccessAuthorizationRuleResource
}

type ListAuthorizationRulesOperationResponse

type ListAuthorizationRulesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SharedAccessAuthorizationRuleResource
}

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NamespaceResource
}

type ListKeysOperationResponse

type ListKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ResourceListKeys
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NamespaceResource
}

type NamespaceCreateOrUpdateParameters

type NamespaceCreateOrUpdateParameters struct {
	Id         *string              `json:"id,omitempty"`
	Location   *string              `json:"location,omitempty"`
	Name       *string              `json:"name,omitempty"`
	Properties *NamespaceProperties `json:"properties,omitempty"`
	Sku        *Sku                 `json:"sku,omitempty"`
	Tags       *map[string]string   `json:"tags,omitempty"`
	Type       *string              `json:"type,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) FromParseResult

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

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 NamespacePatchParameters

type NamespacePatchParameters struct {
	Sku  *Sku               `json:"sku,omitempty"`
	Tags *map[string]string `json:"tags,omitempty"`
}

type NamespaceProperties

type NamespaceProperties struct {
	CreatedAt          *string        `json:"createdAt,omitempty"`
	Critical           *bool          `json:"critical,omitempty"`
	DataCenter         *string        `json:"dataCenter,omitempty"`
	Enabled            *bool          `json:"enabled,omitempty"`
	MetricId           *string        `json:"metricId,omitempty"`
	Name               *string        `json:"name,omitempty"`
	NamespaceType      *NamespaceType `json:"namespaceType,omitempty"`
	ProvisioningState  *string        `json:"provisioningState,omitempty"`
	Region             *string        `json:"region,omitempty"`
	ScaleUnit          *string        `json:"scaleUnit,omitempty"`
	ServiceBusEndpoint *string        `json:"serviceBusEndpoint,omitempty"`
	Status             *string        `json:"status,omitempty"`
	SubscriptionId     *string        `json:"subscriptionId,omitempty"`
	UpdatedAt          *string        `json:"updatedAt,omitempty"`
}

func (*NamespaceProperties) GetCreatedAtAsTime

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

func (*NamespaceProperties) GetUpdatedAtAsTime

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

func (*NamespaceProperties) SetCreatedAtAsTime

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

func (*NamespaceProperties) SetUpdatedAtAsTime

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

type NamespaceResource

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

type NamespaceResourceOperationPredicate

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

func (NamespaceResourceOperationPredicate) Matches

type NamespaceType

type NamespaceType string
const (
	NamespaceTypeMessaging       NamespaceType = "Messaging"
	NamespaceTypeNotificationHub NamespaceType = "NotificationHub"
)

func (*NamespaceType) UnmarshalJSON

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

type NamespacesClient

type NamespacesClient struct {
	Client *resourcemanager.Client
}

func NewNamespacesClientWithBaseURI

func NewNamespacesClientWithBaseURI(sdkApi sdkEnv.Api) (*NamespacesClient, error)

func (NamespacesClient) CheckAvailability

CheckAvailability ...

func (NamespacesClient) CreateOrUpdate

CreateOrUpdate ...

func (NamespacesClient) CreateOrUpdateAuthorizationRule

CreateOrUpdateAuthorizationRule ...

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

Get ...

func (NamespacesClient) GetAuthorizationRule

GetAuthorizationRule ...

func (NamespacesClient) List

List ...

func (NamespacesClient) ListAll

ListAll ...

func (NamespacesClient) ListAllComplete

ListAllComplete retrieves all the results into a single object

func (NamespacesClient) ListAllCompleteMatchingPredicate

func (c NamespacesClient) ListAllCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate NamespaceResourceOperationPredicate) (result ListAllCompleteResult, err error)

ListAllCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NamespacesClient) ListAuthorizationRules

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

ListAuthorizationRules ...

func (NamespacesClient) ListAuthorizationRulesComplete

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

ListAuthorizationRulesComplete retrieves all the results into a single object

func (NamespacesClient) ListAuthorizationRulesCompleteMatchingPredicate

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

ListAuthorizationRulesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NamespacesClient) ListComplete

ListComplete retrieves all the results into a single object

func (NamespacesClient) ListCompleteMatchingPredicate

func (c NamespacesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate NamespaceResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NamespacesClient) ListKeys

ListKeys ...

func (NamespacesClient) Patch

Patch ...

func (NamespacesClient) RegenerateKeys

RegenerateKeys ...

type PatchOperationResponse

type PatchOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NamespaceResource
}

type PolicykeyResource

type PolicykeyResource struct {
	PolicyKey *string `json:"policyKey,omitempty"`
}

type RegenerateKeysOperationResponse

type RegenerateKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ResourceListKeys
}

type ResourceListKeys

type ResourceListKeys 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 SharedAccessAuthorizationRuleCreateOrUpdateParameters

type SharedAccessAuthorizationRuleCreateOrUpdateParameters struct {
	Properties SharedAccessAuthorizationRuleProperties `json:"properties"`
}

type SharedAccessAuthorizationRuleProperties

type SharedAccessAuthorizationRuleProperties struct {
	ClaimType    *string         `json:"claimType,omitempty"`
	ClaimValue   *string         `json:"claimValue,omitempty"`
	CreatedTime  *string         `json:"createdTime,omitempty"`
	KeyName      *string         `json:"keyName,omitempty"`
	ModifiedTime *string         `json:"modifiedTime,omitempty"`
	PrimaryKey   *string         `json:"primaryKey,omitempty"`
	Revision     *int64          `json:"revision,omitempty"`
	Rights       *[]AccessRights `json:"rights,omitempty"`
	SecondaryKey *string         `json:"secondaryKey,omitempty"`
}

type SharedAccessAuthorizationRuleResource

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

type SharedAccessAuthorizationRuleResourceOperationPredicate

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

func (SharedAccessAuthorizationRuleResourceOperationPredicate) Matches

type Sku

type Sku struct {
	Capacity *int64  `json:"capacity,omitempty"`
	Family   *string `json:"family,omitempty"`
	Name     SkuName `json:"name"`
	Size     *string `json:"size,omitempty"`
	Tier     *string `json:"tier,omitempty"`
}

type SkuName

type SkuName string
const (
	SkuNameBasic    SkuName = "Basic"
	SkuNameFree     SkuName = "Free"
	SkuNameStandard SkuName = "Standard"
)

func (*SkuName) UnmarshalJSON

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

Jump to

Keyboard shortcuts

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