notificationhubs

package
v10.1.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Jun 26, 2017 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package notificationhubs implements the Azure ARM Notificationhubs service API version 2017-04-01.

Azure NotificationHub client

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Notificationhubs
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AccessRights 

type AccessRights string

AccessRights enumerates the values for access rights. 

const (
	// Listen specifies the listen state for access rights.
	Listen AccessRights = "Listen"
	// Manage specifies the manage state for access rights.
	Manage AccessRights = "Manage"
	// Send specifies the send state for access rights.
	Send AccessRights = "Send"
)

type AdmCredential 

type AdmCredential struct {
	*AdmCredentialProperties `json:"properties,omitempty"`
}

AdmCredential is description of a NotificationHub AdmCredential.

type AdmCredentialProperties 

type AdmCredentialProperties struct {
	ClientID     *string `json:"clientId,omitempty"`
	ClientSecret *string `json:"clientSecret,omitempty"`
	AuthTokenURL *string `json:"authTokenUrl,omitempty"`
}

AdmCredentialProperties is description of a NotificationHub AdmCredential.

type ApnsCredential 

type ApnsCredential struct {
	*ApnsCredentialProperties `json:"properties,omitempty"`
}

ApnsCredential is description of a NotificationHub ApnsCredential.

type ApnsCredentialProperties 

type ApnsCredentialProperties struct {
	ApnsCertificate *string `json:"apnsCertificate,omitempty"`
	CertificateKey  *string `json:"certificateKey,omitempty"`
	Endpoint        *string `json:"endpoint,omitempty"`
	Thumbprint      *string `json:"thumbprint,omitempty"`
	KeyID           *string `json:"keyId,omitempty"`
	AppName         *string `json:"appName,omitempty"`
	AppID           *string `json:"appId,omitempty"`
	Token           *string `json:"token,omitempty"`
}

ApnsCredentialProperties is description of a NotificationHub ApnsCredential.

type BaiduCredential 

type BaiduCredential struct {
	*BaiduCredentialProperties `json:"properties,omitempty"`
}

BaiduCredential is description of a NotificationHub BaiduCredential.

type BaiduCredentialProperties 

type BaiduCredentialProperties struct {
	BaiduAPIKey    *string `json:"baiduApiKey,omitempty"`
	BaiduEndPoint  *string `json:"baiduEndPoint,omitempty"`
	BaiduSecretKey *string `json:"baiduSecretKey,omitempty"`
}

BaiduCredentialProperties is description of a NotificationHub BaiduCredential.

type CheckAvailabilityParameters 

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

CheckAvailabilityParameters is parameters supplied to the Check Name Availability for Namespace and NotificationHubs.

type CheckAvailabilityResult 

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

CheckAvailabilityResult is description of a CheckAvailibility resource.

type CreateOrUpdateParameters 

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

CreateOrUpdateParameters is parameters supplied to the CreateOrUpdate NotificationHub operation.

type GcmCredential 

type GcmCredential struct {
	*GcmCredentialProperties `json:"properties,omitempty"`
}

GcmCredential is description of a NotificationHub GcmCredential.

type GcmCredentialProperties 

type GcmCredentialProperties struct {
	GcmEndpoint  *string `json:"gcmEndpoint,omitempty"`
	GoogleAPIKey *string `json:"googleApiKey,omitempty"`
}

GcmCredentialProperties is description of a NotificationHub GcmCredential.

type GroupClient 

type GroupClient struct {
	ManagementClient
}

GroupClient is the azure NotificationHub client

func NewGroupClient 

func NewGroupClient(subscriptionID string) GroupClient

NewGroupClient creates an instance of the GroupClient client.

func NewGroupClientWithBaseURI 

func NewGroupClientWithBaseURI(baseURI string, subscriptionID string) GroupClient

NewGroupClientWithBaseURI creates an instance of the GroupClient client.

func (GroupClient) CheckAvailability 

func (client GroupClient) CheckAvailability(resourceGroupName string, namespaceName string, parameters CheckAvailabilityParameters) (result CheckAvailabilityResult, err error)

CheckAvailability checks the availability of the given notificationHub in a namespace.

resourceGroupName is the name of the resource group. namespaceName is the namespace name. parameters is the notificationHub name.

func (GroupClient) CheckAvailabilityPreparer 

func (client GroupClient) CheckAvailabilityPreparer(resourceGroupName string, namespaceName string, parameters CheckAvailabilityParameters) (*http.Request, error)

CheckAvailabilityPreparer prepares the CheckAvailability request.

func (GroupClient) CheckAvailabilityResponder 

func (client GroupClient) CheckAvailabilityResponder(resp *http.Response) (result CheckAvailabilityResult, err error)

CheckAvailabilityResponder handles the response to the CheckAvailability request. The method always closes the http.Response Body.

func (GroupClient) CheckAvailabilitySender 

func (client GroupClient) CheckAvailabilitySender(req *http.Request) (*http.Response, error)

CheckAvailabilitySender sends the CheckAvailability request. The method will close the http.Response Body if it receives an error.

func (GroupClient) CreateOrUpdate 

func (client GroupClient) CreateOrUpdate(resourceGroupName string, namespaceName string, notificationHubName string, parameters CreateOrUpdateParameters) (result ResourceType, err error)

CreateOrUpdate creates/Update a NotificationHub in a namespace.

resourceGroupName is the name of the resource group. namespaceName is the namespace name. notificationHubName is the notification hub name. parameters is parameters supplied to the create/update a NotificationHub Resource.

func (GroupClient) CreateOrUpdateAuthorizationRule 

func (client GroupClient) CreateOrUpdateAuthorizationRule(resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string, parameters SharedAccessAuthorizationRuleCreateOrUpdateParameters) (result SharedAccessAuthorizationRuleResource, err error)

CreateOrUpdateAuthorizationRule creates/Updates an authorization rule for a NotificationHub

resourceGroupName is the name of the resource group. namespaceName is the namespace name. notificationHubName is the notification hub name. authorizationRuleName is authorization Rule Name. parameters is the shared access authorization rule.

func (GroupClient) CreateOrUpdateAuthorizationRulePreparer 

func (client GroupClient) CreateOrUpdateAuthorizationRulePreparer(resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string, parameters SharedAccessAuthorizationRuleCreateOrUpdateParameters) (*http.Request, error)

CreateOrUpdateAuthorizationRulePreparer prepares the CreateOrUpdateAuthorizationRule request.

func (GroupClient) CreateOrUpdateAuthorizationRuleResponder 

func (client GroupClient) CreateOrUpdateAuthorizationRuleResponder(resp *http.Response) (result SharedAccessAuthorizationRuleResource, err error)

CreateOrUpdateAuthorizationRuleResponder handles the response to the CreateOrUpdateAuthorizationRule request. The method always closes the http.Response Body.

func (GroupClient) CreateOrUpdateAuthorizationRuleSender 

func (client GroupClient) CreateOrUpdateAuthorizationRuleSender(req *http.Request) (*http.Response, error)

CreateOrUpdateAuthorizationRuleSender sends the CreateOrUpdateAuthorizationRule request. The method will close the http.Response Body if it receives an error.

func (GroupClient) CreateOrUpdatePreparer 

func (client GroupClient) CreateOrUpdatePreparer(resourceGroupName string, namespaceName string, notificationHubName string, parameters CreateOrUpdateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (GroupClient) CreateOrUpdateResponder 

func (client GroupClient) CreateOrUpdateResponder(resp *http.Response) (result ResourceType, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (GroupClient) CreateOrUpdateSender 

func (client GroupClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (GroupClient) Delete 

func (client GroupClient) Delete(resourceGroupName string, namespaceName string, notificationHubName string) (result autorest.Response, err error)

Delete deletes a notification hub associated with a namespace.

resourceGroupName is the name of the resource group. namespaceName is the namespace name. notificationHubName is the notification hub name.

func (GroupClient) DeleteAuthorizationRule 

func (client GroupClient) DeleteAuthorizationRule(resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string) (result autorest.Response, err error)

DeleteAuthorizationRule deletes a notificationHub authorization rule

resourceGroupName is the name of the resource group. namespaceName is the namespace name. notificationHubName is the notification hub name. authorizationRuleName is authorization Rule Name.

func (GroupClient) DeleteAuthorizationRulePreparer 

func (client GroupClient) DeleteAuthorizationRulePreparer(resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string) (*http.Request, error)

DeleteAuthorizationRulePreparer prepares the DeleteAuthorizationRule request.

func (GroupClient) DeleteAuthorizationRuleResponder 

func (client GroupClient) DeleteAuthorizationRuleResponder(resp *http.Response) (result autorest.Response, err error)

DeleteAuthorizationRuleResponder handles the response to the DeleteAuthorizationRule request. The method always closes the http.Response Body.

func (GroupClient) DeleteAuthorizationRuleSender 

func (client GroupClient) DeleteAuthorizationRuleSender(req *http.Request) (*http.Response, error)

DeleteAuthorizationRuleSender sends the DeleteAuthorizationRule request. The method will close the http.Response Body if it receives an error.

func (GroupClient) DeletePreparer 

func (client GroupClient) DeletePreparer(resourceGroupName string, namespaceName string, notificationHubName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (GroupClient) DeleteResponder 

func (client GroupClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (GroupClient) DeleteSender 

func (client GroupClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (GroupClient) Get 

func (client GroupClient) Get(resourceGroupName string, namespaceName string, notificationHubName string) (result ResourceType, err error)

Get lists the notification hubs associated with a namespace.

resourceGroupName is the name of the resource group. namespaceName is the namespace name. notificationHubName is the notification hub name.

func (GroupClient) GetAuthorizationRule 

func (client GroupClient) GetAuthorizationRule(resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string) (result SharedAccessAuthorizationRuleResource, err error)

GetAuthorizationRule gets an authorization rule for a NotificationHub by name.

resourceGroupName is the name of the resource group. namespaceName is the namespace name notificationHubName is the notification hub name. authorizationRuleName is authorization rule name.

func (GroupClient) GetAuthorizationRulePreparer 

func (client GroupClient) GetAuthorizationRulePreparer(resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string) (*http.Request, error)

GetAuthorizationRulePreparer prepares the GetAuthorizationRule request.

func (GroupClient) GetAuthorizationRuleResponder 

func (client GroupClient) GetAuthorizationRuleResponder(resp *http.Response) (result SharedAccessAuthorizationRuleResource, err error)

GetAuthorizationRuleResponder handles the response to the GetAuthorizationRule request. The method always closes the http.Response Body.

func (GroupClient) GetAuthorizationRuleSender 

func (client GroupClient) GetAuthorizationRuleSender(req *http.Request) (*http.Response, error)

GetAuthorizationRuleSender sends the GetAuthorizationRule request. The method will close the http.Response Body if it receives an error.

func (GroupClient) GetPnsCredentials 

func (client GroupClient) GetPnsCredentials(resourceGroupName string, namespaceName string, notificationHubName string) (result PnsCredentialsResource, err error)

GetPnsCredentials lists the PNS Credentials associated with a notification hub .

resourceGroupName is the name of the resource group. namespaceName is the namespace name. notificationHubName is the notification hub name.

func (GroupClient) GetPnsCredentialsPreparer 

func (client GroupClient) GetPnsCredentialsPreparer(resourceGroupName string, namespaceName string, notificationHubName string) (*http.Request, error)

GetPnsCredentialsPreparer prepares the GetPnsCredentials request.

func (GroupClient) GetPnsCredentialsResponder 

func (client GroupClient) GetPnsCredentialsResponder(resp *http.Response) (result PnsCredentialsResource, err error)

GetPnsCredentialsResponder handles the response to the GetPnsCredentials request. The method always closes the http.Response Body.

func (GroupClient) GetPnsCredentialsSender 

func (client GroupClient) GetPnsCredentialsSender(req *http.Request) (*http.Response, error)

GetPnsCredentialsSender sends the GetPnsCredentials request. The method will close the http.Response Body if it receives an error.

func (GroupClient) GetPreparer 

func (client GroupClient) GetPreparer(resourceGroupName string, namespaceName string, notificationHubName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (GroupClient) GetResponder 

func (client GroupClient) GetResponder(resp *http.Response) (result ResourceType, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (GroupClient) GetSender 

func (client GroupClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (GroupClient) List 

func (client GroupClient) List(resourceGroupName string, namespaceName string) (result ListResult, err error)

List lists the notification hubs associated with a namespace.

resourceGroupName is the name of the resource group. namespaceName is the namespace name.

func (GroupClient) ListAuthorizationRules 

func (client GroupClient) ListAuthorizationRules(resourceGroupName string, namespaceName string, notificationHubName string) (result SharedAccessAuthorizationRuleListResult, err error)

ListAuthorizationRules gets the authorization rules for a NotificationHub.

resourceGroupName is the name of the resource group. namespaceName is the namespace name notificationHubName is the notification hub name.

func (GroupClient) ListAuthorizationRulesNextResults 

func (client GroupClient) ListAuthorizationRulesNextResults(lastResults SharedAccessAuthorizationRuleListResult) (result SharedAccessAuthorizationRuleListResult, err error)

ListAuthorizationRulesNextResults retrieves the next set of results, if any.

func (GroupClient) ListAuthorizationRulesPreparer 

func (client GroupClient) ListAuthorizationRulesPreparer(resourceGroupName string, namespaceName string, notificationHubName string) (*http.Request, error)

ListAuthorizationRulesPreparer prepares the ListAuthorizationRules request.

func (GroupClient) ListAuthorizationRulesResponder 

func (client GroupClient) ListAuthorizationRulesResponder(resp *http.Response) (result SharedAccessAuthorizationRuleListResult, err error)

ListAuthorizationRulesResponder handles the response to the ListAuthorizationRules request. The method always closes the http.Response Body.

func (GroupClient) ListAuthorizationRulesSender 

func (client GroupClient) ListAuthorizationRulesSender(req *http.Request) (*http.Response, error)

ListAuthorizationRulesSender sends the ListAuthorizationRules request. The method will close the http.Response Body if it receives an error.

func (GroupClient) ListKeys 

func (client GroupClient) ListKeys(resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string) (result ResourceListKeys, err error)

ListKeys gets the Primary and Secondary ConnectionStrings to the NotificationHub

resourceGroupName is the name of the resource group. namespaceName is the namespace name. notificationHubName is the notification hub name. authorizationRuleName is the connection string of the NotificationHub for the specified authorizationRule.

func (GroupClient) ListKeysPreparer 

func (client GroupClient) ListKeysPreparer(resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (GroupClient) ListKeysResponder 

func (client GroupClient) ListKeysResponder(resp *http.Response) (result ResourceListKeys, err error)

ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.

func (GroupClient) ListKeysSender 

func (client GroupClient) ListKeysSender(req *http.Request) (*http.Response, error)

ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.

func (GroupClient) ListNextResults 

func (client GroupClient) ListNextResults(lastResults ListResult) (result ListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (GroupClient) ListPreparer 

func (client GroupClient) ListPreparer(resourceGroupName string, namespaceName string) (*http.Request, error)

ListPreparer prepares the List request.

func (GroupClient) ListResponder 

func (client GroupClient) ListResponder(resp *http.Response) (result ListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (GroupClient) ListSender 

func (client GroupClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (GroupClient) RegenerateKeys 

func (client GroupClient) RegenerateKeys(resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string, parameters PolicykeyResource) (result ResourceListKeys, err error)

RegenerateKeys regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule

resourceGroupName is the name of the resource group. namespaceName is the namespace name. notificationHubName is the notification hub name. authorizationRuleName is the connection string of the NotificationHub for the specified authorizationRule. parameters is parameters supplied to regenerate the NotificationHub Authorization Rule Key.

func (GroupClient) RegenerateKeysPreparer 

func (client GroupClient) RegenerateKeysPreparer(resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string, parameters PolicykeyResource) (*http.Request, error)

RegenerateKeysPreparer prepares the RegenerateKeys request.

func (GroupClient) RegenerateKeysResponder 

func (client GroupClient) RegenerateKeysResponder(resp *http.Response) (result ResourceListKeys, err error)

RegenerateKeysResponder handles the response to the RegenerateKeys request. The method always closes the http.Response Body.

func (GroupClient) RegenerateKeysSender 

func (client GroupClient) RegenerateKeysSender(req *http.Request) (*http.Response, error)

RegenerateKeysSender sends the RegenerateKeys request. The method will close the http.Response Body if it receives an error.

type ListResult 

type ListResult struct {
	autorest.Response `json:"-"`
	Value             *[]ResourceType `json:"value,omitempty"`
	NextLink          *string         `json:"nextLink,omitempty"`
}

ListResult is the response of the List NotificationHub operation.

func (ListResult) ListResultPreparer 

func (client ListResult) ListResultPreparer() (*http.Request, error)

ListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type ManagementClient 

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

ManagementClient is the base client for Notificationhubs.

func New 

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type MpnsCredential 

type MpnsCredential struct {
	*MpnsCredentialProperties `json:"properties,omitempty"`
}

MpnsCredential is description of a NotificationHub MpnsCredential.

type MpnsCredentialProperties 

type MpnsCredentialProperties struct {
	MpnsCertificate *string `json:"mpnsCertificate,omitempty"`
	CertificateKey  *string `json:"certificateKey,omitempty"`
	Thumbprint      *string `json:"thumbprint,omitempty"`
}

MpnsCredentialProperties is description of a NotificationHub MpnsCredential.

type NamespaceCreateOrUpdateParameters 

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

NamespaceCreateOrUpdateParameters is parameters supplied to the CreateOrUpdate Namespace operation.

type NamespaceListResult 

type NamespaceListResult struct {
	autorest.Response `json:"-"`
	Value             *[]NamespaceResource `json:"value,omitempty"`
	NextLink          *string              `json:"nextLink,omitempty"`
}

NamespaceListResult is the response of the List Namespace operation.

func (NamespaceListResult) NamespaceListResultPreparer 

func (client NamespaceListResult) NamespaceListResultPreparer() (*http.Request, error)

NamespaceListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type NamespacePatchParameters 

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

NamespacePatchParameters is parameters supplied to the Patch Namespace operation.

type NamespaceProperties 

type NamespaceProperties struct {
	Name               *string       `json:"name,omitempty"`
	ProvisioningState  *string       `json:"provisioningState,omitempty"`
	Region             *string       `json:"region,omitempty"`
	Status             *string       `json:"status,omitempty"`
	CreatedAt          *date.Time    `json:"createdAt,omitempty"`
	ServiceBusEndpoint *string       `json:"serviceBusEndpoint,omitempty"`
	SubscriptionID     *string       `json:"subscriptionId,omitempty"`
	ScaleUnit          *string       `json:"scaleUnit,omitempty"`
	Enabled            *bool         `json:"enabled,omitempty"`
	Critical           *bool         `json:"critical,omitempty"`
	NamespaceType      NamespaceType `json:"namespaceType,omitempty"`
}

NamespaceProperties is namespace properties.

type NamespaceResource 

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

NamespaceResource is description of a Namespace resource.

type NamespaceType 

type NamespaceType string

NamespaceType enumerates the values for namespace type. 

const (
	// Messaging specifies the messaging state for namespace type.
	Messaging NamespaceType = "Messaging"
	// NotificationHub specifies the notification hub state for namespace type.
	NotificationHub NamespaceType = "NotificationHub"
)

type NamespacesClient 

type NamespacesClient struct {
	ManagementClient
}

NamespacesClient is the azure NotificationHub client

func NewNamespacesClient 

func NewNamespacesClient(subscriptionID string) NamespacesClient

NewNamespacesClient creates an instance of the NamespacesClient client.

func NewNamespacesClientWithBaseURI 

func NewNamespacesClientWithBaseURI(baseURI string, subscriptionID string) NamespacesClient

NewNamespacesClientWithBaseURI creates an instance of the NamespacesClient client.

func (NamespacesClient) CheckAvailability 

func (client NamespacesClient) CheckAvailability(parameters CheckAvailabilityParameters) (result CheckAvailabilityResult, err error)

CheckAvailability checks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.

parameters is the namespace name.

func (NamespacesClient) CheckAvailabilityPreparer 

func (client NamespacesClient) CheckAvailabilityPreparer(parameters CheckAvailabilityParameters) (*http.Request, error)

CheckAvailabilityPreparer prepares the CheckAvailability request.

func (NamespacesClient) CheckAvailabilityResponder 

func (client NamespacesClient) CheckAvailabilityResponder(resp *http.Response) (result CheckAvailabilityResult, err error)

CheckAvailabilityResponder handles the response to the CheckAvailability request. The method always closes the http.Response Body.

func (NamespacesClient) CheckAvailabilitySender 

func (client NamespacesClient) CheckAvailabilitySender(req *http.Request) (*http.Response, error)

CheckAvailabilitySender sends the CheckAvailability request. The method will close the http.Response Body if it receives an error.

func (NamespacesClient) CreateOrUpdate 

func (client NamespacesClient) CreateOrUpdate(resourceGroupName string, namespaceName string, parameters NamespaceCreateOrUpdateParameters) (result NamespaceResource, err error)

CreateOrUpdate creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

resourceGroupName is the name of the resource group. namespaceName is the namespace name. parameters is parameters supplied to create a Namespace Resource.

func (NamespacesClient) CreateOrUpdateAuthorizationRule 

func (client NamespacesClient) CreateOrUpdateAuthorizationRule(resourceGroupName string, namespaceName string, authorizationRuleName string, parameters SharedAccessAuthorizationRuleCreateOrUpdateParameters) (result SharedAccessAuthorizationRuleResource, err error)

CreateOrUpdateAuthorizationRule creates an authorization rule for a namespace

resourceGroupName is the name of the resource group. namespaceName is the namespace name. authorizationRuleName is aauthorization Rule Name. parameters is the shared access authorization rule.

func (NamespacesClient) CreateOrUpdateAuthorizationRulePreparer 

func (client NamespacesClient) CreateOrUpdateAuthorizationRulePreparer(resourceGroupName string, namespaceName string, authorizationRuleName string, parameters SharedAccessAuthorizationRuleCreateOrUpdateParameters) (*http.Request, error)

CreateOrUpdateAuthorizationRulePreparer prepares the CreateOrUpdateAuthorizationRule request.

func (NamespacesClient) CreateOrUpdateAuthorizationRuleResponder 

func (client NamespacesClient) CreateOrUpdateAuthorizationRuleResponder(resp *http.Response) (result SharedAccessAuthorizationRuleResource, err error)

CreateOrUpdateAuthorizationRuleResponder handles the response to the CreateOrUpdateAuthorizationRule request. The method always closes the http.Response Body.

func (NamespacesClient) CreateOrUpdateAuthorizationRuleSender 

func (client NamespacesClient) CreateOrUpdateAuthorizationRuleSender(req *http.Request) (*http.Response, error)

CreateOrUpdateAuthorizationRuleSender sends the CreateOrUpdateAuthorizationRule request. The method will close the http.Response Body if it receives an error.

func (NamespacesClient) CreateOrUpdatePreparer 

func (client NamespacesClient) CreateOrUpdatePreparer(resourceGroupName string, namespaceName string, parameters NamespaceCreateOrUpdateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (NamespacesClient) CreateOrUpdateResponder 

func (client NamespacesClient) CreateOrUpdateResponder(resp *http.Response) (result NamespaceResource, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (NamespacesClient) CreateOrUpdateSender 

func (client NamespacesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (NamespacesClient) Delete 

func (client NamespacesClient) Delete(resourceGroupName string, namespaceName string, cancel <-chan struct{}) (<-chan autorest.Response, <-chan error)

Delete deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group. namespaceName is the namespace name.

func (NamespacesClient) DeleteAuthorizationRule 

func (client NamespacesClient) DeleteAuthorizationRule(resourceGroupName string, namespaceName string, authorizationRuleName string) (result autorest.Response, err error)

DeleteAuthorizationRule deletes a namespace authorization rule

resourceGroupName is the name of the resource group. namespaceName is the namespace name. authorizationRuleName is authorization Rule Name.

func (NamespacesClient) DeleteAuthorizationRulePreparer 

func (client NamespacesClient) DeleteAuthorizationRulePreparer(resourceGroupName string, namespaceName string, authorizationRuleName string) (*http.Request, error)

DeleteAuthorizationRulePreparer prepares the DeleteAuthorizationRule request.

func (NamespacesClient) DeleteAuthorizationRuleResponder 

func (client NamespacesClient) DeleteAuthorizationRuleResponder(resp *http.Response) (result autorest.Response, err error)

DeleteAuthorizationRuleResponder handles the response to the DeleteAuthorizationRule request. The method always closes the http.Response Body.

func (NamespacesClient) DeleteAuthorizationRuleSender 

func (client NamespacesClient) DeleteAuthorizationRuleSender(req *http.Request) (*http.Response, error)

DeleteAuthorizationRuleSender sends the DeleteAuthorizationRule request. The method will close the http.Response Body if it receives an error.

func (NamespacesClient) DeletePreparer 

func (client NamespacesClient) DeletePreparer(resourceGroupName string, namespaceName string, cancel <-chan struct{}) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (NamespacesClient) DeleteResponder 

func (client NamespacesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (NamespacesClient) DeleteSender 

func (client NamespacesClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (NamespacesClient) Get 

func (client NamespacesClient) Get(resourceGroupName string, namespaceName string) (result NamespaceResource, err error)

Get returns the description for the specified namespace.

resourceGroupName is the name of the resource group. namespaceName is the namespace name.

func (NamespacesClient) GetAuthorizationRule 

func (client NamespacesClient) GetAuthorizationRule(resourceGroupName string, namespaceName string, authorizationRuleName string) (result SharedAccessAuthorizationRuleResource, err error)

GetAuthorizationRule gets an authorization rule for a namespace by name.

resourceGroupName is the name of the resource group. namespaceName is the namespace name authorizationRuleName is authorization rule name.

func (NamespacesClient) GetAuthorizationRulePreparer 

func (client NamespacesClient) GetAuthorizationRulePreparer(resourceGroupName string, namespaceName string, authorizationRuleName string) (*http.Request, error)

GetAuthorizationRulePreparer prepares the GetAuthorizationRule request.

func (NamespacesClient) GetAuthorizationRuleResponder 

func (client NamespacesClient) GetAuthorizationRuleResponder(resp *http.Response) (result SharedAccessAuthorizationRuleResource, err error)

GetAuthorizationRuleResponder handles the response to the GetAuthorizationRule request. The method always closes the http.Response Body.

func (NamespacesClient) GetAuthorizationRuleSender 

func (client NamespacesClient) GetAuthorizationRuleSender(req *http.Request) (*http.Response, error)

GetAuthorizationRuleSender sends the GetAuthorizationRule request. The method will close the http.Response Body if it receives an error.

func (NamespacesClient) GetPreparer 

func (client NamespacesClient) GetPreparer(resourceGroupName string, namespaceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (NamespacesClient) GetResponder 

func (client NamespacesClient) GetResponder(resp *http.Response) (result NamespaceResource, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (NamespacesClient) GetSender 

func (client NamespacesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (NamespacesClient) List 

func (client NamespacesClient) List(resourceGroupName string) (result NamespaceListResult, err error)

List lists the available namespaces within a resourceGroup.

resourceGroupName is the name of the resource group. If resourceGroupName value is null the method lists all the namespaces within subscription

func (NamespacesClient) ListAll 

func (client NamespacesClient) ListAll() (result NamespaceListResult, err error)

ListAll lists all the available namespaces within the subscription irrespective of the resourceGroups.

func (NamespacesClient) ListAllNextResults 

func (client NamespacesClient) ListAllNextResults(lastResults NamespaceListResult) (result NamespaceListResult, err error)

ListAllNextResults retrieves the next set of results, if any.

func (NamespacesClient) ListAllPreparer 

func (client NamespacesClient) ListAllPreparer() (*http.Request, error)

ListAllPreparer prepares the ListAll request.

func (NamespacesClient) ListAllResponder 

func (client NamespacesClient) ListAllResponder(resp *http.Response) (result NamespaceListResult, err error)

ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.

func (NamespacesClient) ListAllSender 

func (client NamespacesClient) ListAllSender(req *http.Request) (*http.Response, error)

ListAllSender sends the ListAll request. The method will close the http.Response Body if it receives an error.

func (NamespacesClient) ListAuthorizationRules 

func (client NamespacesClient) ListAuthorizationRules(resourceGroupName string, namespaceName string) (result SharedAccessAuthorizationRuleListResult, err error)

ListAuthorizationRules gets the authorization rules for a namespace.

resourceGroupName is the name of the resource group. namespaceName is the namespace name

func (NamespacesClient) ListAuthorizationRulesNextResults 

func (client NamespacesClient) ListAuthorizationRulesNextResults(lastResults SharedAccessAuthorizationRuleListResult) (result SharedAccessAuthorizationRuleListResult, err error)

ListAuthorizationRulesNextResults retrieves the next set of results, if any.

func (NamespacesClient) ListAuthorizationRulesPreparer 

func (client NamespacesClient) ListAuthorizationRulesPreparer(resourceGroupName string, namespaceName string) (*http.Request, error)

ListAuthorizationRulesPreparer prepares the ListAuthorizationRules request.

func (NamespacesClient) ListAuthorizationRulesResponder 

func (client NamespacesClient) ListAuthorizationRulesResponder(resp *http.Response) (result SharedAccessAuthorizationRuleListResult, err error)

ListAuthorizationRulesResponder handles the response to the ListAuthorizationRules request. The method always closes the http.Response Body.

func (NamespacesClient) ListAuthorizationRulesSender 

func (client NamespacesClient) ListAuthorizationRulesSender(req *http.Request) (*http.Response, error)

ListAuthorizationRulesSender sends the ListAuthorizationRules request. The method will close the http.Response Body if it receives an error.

func (NamespacesClient) ListKeys 

func (client NamespacesClient) ListKeys(resourceGroupName string, namespaceName string, authorizationRuleName string) (result ResourceListKeys, err error)

ListKeys gets the Primary and Secondary ConnectionStrings to the namespace

resourceGroupName is the name of the resource group. namespaceName is the namespace name. authorizationRuleName is the connection string of the namespace for the specified authorizationRule.

func (NamespacesClient) ListKeysPreparer 

func (client NamespacesClient) ListKeysPreparer(resourceGroupName string, namespaceName string, authorizationRuleName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (NamespacesClient) ListKeysResponder 

func (client NamespacesClient) ListKeysResponder(resp *http.Response) (result ResourceListKeys, err error)

ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.

func (NamespacesClient) ListKeysSender 

func (client NamespacesClient) ListKeysSender(req *http.Request) (*http.Response, error)

ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.

func (NamespacesClient) ListNextResults 

func (client NamespacesClient) ListNextResults(lastResults NamespaceListResult) (result NamespaceListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (NamespacesClient) ListPreparer 

func (client NamespacesClient) ListPreparer(resourceGroupName string) (*http.Request, error)

ListPreparer prepares the List request.

func (NamespacesClient) ListResponder 

func (client NamespacesClient) ListResponder(resp *http.Response) (result NamespaceListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (NamespacesClient) ListSender 

func (client NamespacesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (NamespacesClient) Patch 

func (client NamespacesClient) Patch(resourceGroupName string, namespaceName string, parameters NamespacePatchParameters) (result NamespaceResource, err error)

Patch patches the existing namespace

resourceGroupName is the name of the resource group. namespaceName is the namespace name. parameters is parameters supplied to patch a Namespace Resource.

func (NamespacesClient) PatchPreparer 

func (client NamespacesClient) PatchPreparer(resourceGroupName string, namespaceName string, parameters NamespacePatchParameters) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (NamespacesClient) PatchResponder 

func (client NamespacesClient) PatchResponder(resp *http.Response) (result NamespaceResource, err error)

PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.

func (NamespacesClient) PatchSender 

func (client NamespacesClient) PatchSender(req *http.Request) (*http.Response, error)

PatchSender sends the Patch request. The method will close the http.Response Body if it receives an error.

func (NamespacesClient) RegenerateKeys 

func (client NamespacesClient) RegenerateKeys(resourceGroupName string, namespaceName string, authorizationRuleName string, parameters PolicykeyResource) (result ResourceListKeys, err error)

RegenerateKeys regenerates the Primary/Secondary Keys to the Namespace Authorization Rule

resourceGroupName is the name of the resource group. namespaceName is the namespace name. authorizationRuleName is the connection string of the namespace for the specified authorizationRule. parameters is parameters supplied to regenerate the Namespace Authorization Rule Key.

func (NamespacesClient) RegenerateKeysPreparer 

func (client NamespacesClient) RegenerateKeysPreparer(resourceGroupName string, namespaceName string, authorizationRuleName string, parameters PolicykeyResource) (*http.Request, error)

RegenerateKeysPreparer prepares the RegenerateKeys request.

func (NamespacesClient) RegenerateKeysResponder 

func (client NamespacesClient) RegenerateKeysResponder(resp *http.Response) (result ResourceListKeys, err error)

RegenerateKeysResponder handles the response to the RegenerateKeys request. The method always closes the http.Response Body.

func (NamespacesClient) RegenerateKeysSender 

func (client NamespacesClient) RegenerateKeysSender(req *http.Request) (*http.Response, error)

RegenerateKeysSender sends the RegenerateKeys request. The method will close the http.Response Body if it receives an error.

type PnsCredentialsProperties 

type PnsCredentialsProperties struct {
	ApnsCredential  *ApnsCredential  `json:"apnsCredential,omitempty"`
	WnsCredential   *WnsCredential   `json:"wnsCredential,omitempty"`
	GcmCredential   *GcmCredential   `json:"gcmCredential,omitempty"`
	MpnsCredential  *MpnsCredential  `json:"mpnsCredential,omitempty"`
	AdmCredential   *AdmCredential   `json:"admCredential,omitempty"`
	BaiduCredential *BaiduCredential `json:"baiduCredential,omitempty"`
}

PnsCredentialsProperties is description of a NotificationHub PNS Credentials.

type PnsCredentialsResource 

type PnsCredentialsResource struct {
	autorest.Response         `json:"-"`
	ID                        *string             `json:"id,omitempty"`
	Name                      *string             `json:"name,omitempty"`
	Type                      *string             `json:"type,omitempty"`
	Location                  *string             `json:"location,omitempty"`
	Tags                      *map[string]*string `json:"tags,omitempty"`
	Sku                       *Sku                `json:"sku,omitempty"`
	*PnsCredentialsProperties `json:"properties,omitempty"`
}

PnsCredentialsResource is description of a NotificationHub PNS Credentials.

type PolicykeyResource 

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

PolicykeyResource is namespace/NotificationHub Regenerate Keys

type Properties 

type Properties struct {
	Name               *string                                    `json:"name,omitempty"`
	RegistrationTTL    *string                                    `json:"registrationTtl,omitempty"`
	AuthorizationRules *[]SharedAccessAuthorizationRuleProperties `json:"authorizationRules,omitempty"`
	ApnsCredential     *ApnsCredential                            `json:"apnsCredential,omitempty"`
	WnsCredential      *WnsCredential                             `json:"wnsCredential,omitempty"`
	GcmCredential      *GcmCredential                             `json:"gcmCredential,omitempty"`
	MpnsCredential     *MpnsCredential                            `json:"mpnsCredential,omitempty"`
	AdmCredential      *AdmCredential                             `json:"admCredential,omitempty"`
	BaiduCredential    *BaiduCredential                           `json:"baiduCredential,omitempty"`
}

Properties is notificationHub properties.

type Resource 

type Resource struct {
	ID       *string             `json:"id,omitempty"`
	Name     *string             `json:"name,omitempty"`
	Type     *string             `json:"type,omitempty"`
	Location *string             `json:"location,omitempty"`
	Tags     *map[string]*string `json:"tags,omitempty"`
	Sku      *Sku                `json:"sku,omitempty"`
}

Resource is

type ResourceListKeys 

type ResourceListKeys struct {
	autorest.Response         `json:"-"`
	PrimaryConnectionString   *string `json:"primaryConnectionString,omitempty"`
	SecondaryConnectionString *string `json:"secondaryConnectionString,omitempty"`
	PrimaryKey                *string `json:"primaryKey,omitempty"`
	SecondaryKey              *string `json:"secondaryKey,omitempty"`
	KeyName                   *string `json:"keyName,omitempty"`
}

ResourceListKeys is namespace/NotificationHub Connection String

type ResourceType 

type ResourceType struct {
	autorest.Response `json:"-"`
	ID                *string             `json:"id,omitempty"`
	Name              *string             `json:"name,omitempty"`
	Type              *string             `json:"type,omitempty"`
	Location          *string             `json:"location,omitempty"`
	Tags              *map[string]*string `json:"tags,omitempty"`
	Sku               *Sku                `json:"sku,omitempty"`
	*Properties       `json:"properties,omitempty"`
}

ResourceType is description of a NotificationHub Resource.

type SharedAccessAuthorizationRuleCreateOrUpdateParameters 

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

SharedAccessAuthorizationRuleCreateOrUpdateParameters is parameters supplied to the CreateOrUpdate Namespace AuthorizationRules.

type SharedAccessAuthorizationRuleListResult 

type SharedAccessAuthorizationRuleListResult struct {
	autorest.Response `json:"-"`
	Value             *[]SharedAccessAuthorizationRuleResource `json:"value,omitempty"`
	NextLink          *string                                  `json:"nextLink,omitempty"`
}

SharedAccessAuthorizationRuleListResult is the response of the List Namespace operation.

func (SharedAccessAuthorizationRuleListResult) SharedAccessAuthorizationRuleListResultPreparer 

func (client SharedAccessAuthorizationRuleListResult) SharedAccessAuthorizationRuleListResultPreparer() (*http.Request, error)

SharedAccessAuthorizationRuleListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type SharedAccessAuthorizationRuleProperties 

type SharedAccessAuthorizationRuleProperties struct {
	Rights *[]AccessRights `json:"rights,omitempty"`
}

SharedAccessAuthorizationRuleProperties is sharedAccessAuthorizationRule properties.

type SharedAccessAuthorizationRuleResource 

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

SharedAccessAuthorizationRuleResource is description of a Namespace AuthorizationRules.

type Sku 

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

Sku is the Sku description for a namespace

type SkuName 

type SkuName string

SkuName enumerates the values for sku name. 

const (
	// Basic specifies the basic state for sku name.
	Basic SkuName = "Basic"
	// Free specifies the free state for sku name.
	Free SkuName = "Free"
	// Standard specifies the standard state for sku name.
	Standard SkuName = "Standard"
)

type SubResource 

type SubResource struct {
	ID *string `json:"id,omitempty"`
}

SubResource is

type WnsCredential 

type WnsCredential struct {
	*WnsCredentialProperties `json:"properties,omitempty"`
}

WnsCredential is description of a NotificationHub WnsCredential.

type WnsCredentialProperties 

type WnsCredentialProperties struct {
	PackageSid          *string `json:"packageSid,omitempty"`
	SecretKey           *string `json:"secretKey,omitempty"`
	WindowsLiveEndpoint *string `json:"windowsLiveEndpoint,omitempty"`
}

WnsCredentialProperties is description of a NotificationHub WnsCredential.

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.