Documentation ¶
Overview ¶
Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/notificationhubs/armnotificationhubs(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/notificationhubs/armnotificationhubs). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.
Package notificationhubs implements the Azure ARM Notificationhubs service API version 2017-04-01.
Azure NotificationHub client
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type AccessRights
- type AdmCredential
- type AdmCredentialProperties
- type ApnsCredential
- type ApnsCredentialProperties
- type BaiduCredential
- type BaiduCredentialProperties
- type BaseClient
- type CheckAvailabilityParameters
- type CheckAvailabilityResult
- type Client
- func (client Client) CheckNotificationHubAvailability(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result CheckAvailabilityResult, err error)
- func (client Client) CheckNotificationHubAvailabilityPreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client Client) CheckNotificationHubAvailabilityResponder(resp *http.Response) (result CheckAvailabilityResult, err error)
- func (client Client) CheckNotificationHubAvailabilitySender(req *http.Request) (*http.Response, error)
- func (client Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result ResourceType, err error)
- func (client Client) CreateOrUpdateAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result SharedAccessAuthorizationRuleResource, err error)
- func (client Client) CreateOrUpdateAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client Client) CreateOrUpdateAuthorizationRuleResponder(resp *http.Response) (result SharedAccessAuthorizationRuleResource, err error)
- func (client Client) CreateOrUpdateAuthorizationRuleSender(req *http.Request) (*http.Response, error)
- func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client Client) CreateOrUpdateResponder(resp *http.Response) (result ResourceType, err error)
- func (client Client) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client Client) DebugSend(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result DebugSendResponse, err error)
- func (client Client) DebugSendPreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client Client) DebugSendResponder(resp *http.Response) (result DebugSendResponse, err error)
- func (client Client) DebugSendSender(req *http.Request) (*http.Response, error)
- func (client Client) Delete(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result autorest.Response, err error)
- func (client Client) DeleteAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result autorest.Response, err error)
- func (client Client) DeleteAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client Client) DeleteAuthorizationRuleResponder(resp *http.Response) (result autorest.Response, err error)
- func (client Client) DeleteAuthorizationRuleSender(req *http.Request) (*http.Response, error)
- func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client Client) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client Client) DeleteSender(req *http.Request) (*http.Response, error)
- func (client Client) Get(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result ResourceType, err error)
- func (client Client) GetAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result SharedAccessAuthorizationRuleResource, err error)
- func (client Client) GetAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client Client) GetAuthorizationRuleResponder(resp *http.Response) (result SharedAccessAuthorizationRuleResource, err error)
- func (client Client) GetAuthorizationRuleSender(req *http.Request) (*http.Response, error)
- func (client Client) GetPnsCredentials(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result PnsCredentialsResource, err error)
- func (client Client) GetPnsCredentialsPreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client Client) GetPnsCredentialsResponder(resp *http.Response) (result PnsCredentialsResource, err error)
- func (client Client) GetPnsCredentialsSender(req *http.Request) (*http.Response, error)
- func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client Client) GetResponder(resp *http.Response) (result ResourceType, err error)
- func (client Client) GetSender(req *http.Request) (*http.Response, error)
- func (client Client) List(ctx context.Context, resourceGroupName string, namespaceName string) (result ListResultPage, err error)
- func (client Client) ListAuthorizationRules(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result SharedAccessAuthorizationRuleListResultPage, err error)
- func (client Client) ListAuthorizationRulesComplete(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result SharedAccessAuthorizationRuleListResultIterator, err error)
- func (client Client) ListAuthorizationRulesPreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client Client) ListAuthorizationRulesResponder(resp *http.Response) (result SharedAccessAuthorizationRuleListResult, err error)
- func (client Client) ListAuthorizationRulesSender(req *http.Request) (*http.Response, error)
- func (client Client) ListComplete(ctx context.Context, resourceGroupName string, namespaceName string) (result ListResultIterator, err error)
- func (client Client) ListKeys(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result ResourceListKeys, err error)
- func (client Client) ListKeysPreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client Client) ListKeysResponder(resp *http.Response) (result ResourceListKeys, err error)
- func (client Client) ListKeysSender(req *http.Request) (*http.Response, error)
- func (client Client) ListPreparer(ctx context.Context, resourceGroupName string, namespaceName string) (*http.Request, error)
- func (client Client) ListResponder(resp *http.Response) (result ListResult, err error)
- func (client Client) ListSender(req *http.Request) (*http.Response, error)
- func (client Client) Patch(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result ResourceType, err error)
- func (client Client) PatchPreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client Client) PatchResponder(resp *http.Response) (result ResourceType, err error)
- func (client Client) PatchSender(req *http.Request) (*http.Response, error)
- func (client Client) RegenerateKeys(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result ResourceListKeys, err error)
- func (client Client) RegenerateKeysPreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client Client) RegenerateKeysResponder(resp *http.Response) (result ResourceListKeys, err error)
- func (client Client) RegenerateKeysSender(req *http.Request) (*http.Response, error)
- type CreateOrUpdateParameters
- type DebugSendResponse
- type DebugSendResult
- type ErrorResponse
- type GcmCredential
- type GcmCredentialProperties
- type ListResult
- type ListResultIterator
- type ListResultPage
- type MpnsCredential
- type MpnsCredentialProperties
- type NamespaceCreateOrUpdateParameters
- type NamespaceListResult
- type NamespaceListResultIterator
- func (iter *NamespaceListResultIterator) Next() error
- func (iter *NamespaceListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter NamespaceListResultIterator) NotDone() bool
- func (iter NamespaceListResultIterator) Response() NamespaceListResult
- func (iter NamespaceListResultIterator) Value() NamespaceResource
- type NamespaceListResultPage
- func (page *NamespaceListResultPage) Next() error
- func (page *NamespaceListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page NamespaceListResultPage) NotDone() bool
- func (page NamespaceListResultPage) Response() NamespaceListResult
- func (page NamespaceListResultPage) Values() []NamespaceResource
- type NamespacePatchParameters
- type NamespaceProperties
- type NamespaceResource
- type NamespaceType
- type NamespacesClient
- func (client NamespacesClient) CheckAvailability(ctx context.Context, parameters CheckAvailabilityParameters) (result CheckAvailabilityResult, err error)
- func (client NamespacesClient) CheckAvailabilityPreparer(ctx context.Context, parameters CheckAvailabilityParameters) (*http.Request, error)
- func (client NamespacesClient) CheckAvailabilityResponder(resp *http.Response) (result CheckAvailabilityResult, err error)
- func (client NamespacesClient) CheckAvailabilitySender(req *http.Request) (*http.Response, error)
- func (client NamespacesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result NamespaceResource, err error)
- func (client NamespacesClient) CreateOrUpdateAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result SharedAccessAuthorizationRuleResource, err error)
- func (client NamespacesClient) CreateOrUpdateAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client NamespacesClient) CreateOrUpdateAuthorizationRuleResponder(resp *http.Response) (result SharedAccessAuthorizationRuleResource, err error)
- func (client NamespacesClient) CreateOrUpdateAuthorizationRuleSender(req *http.Request) (*http.Response, error)
- func (client NamespacesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client NamespacesClient) CreateOrUpdateResponder(resp *http.Response) (result NamespaceResource, err error)
- func (client NamespacesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client NamespacesClient) Delete(ctx context.Context, resourceGroupName string, namespaceName string) (result NamespacesDeleteFuture, err error)
- func (client NamespacesClient) DeleteAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result autorest.Response, err error)
- func (client NamespacesClient) DeleteAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client NamespacesClient) DeleteAuthorizationRuleResponder(resp *http.Response) (result autorest.Response, err error)
- func (client NamespacesClient) DeleteAuthorizationRuleSender(req *http.Request) (*http.Response, error)
- func (client NamespacesClient) DeletePreparer(ctx context.Context, resourceGroupName string, namespaceName string) (*http.Request, error)
- func (client NamespacesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client NamespacesClient) DeleteSender(req *http.Request) (future NamespacesDeleteFuture, err error)
- func (client NamespacesClient) Get(ctx context.Context, resourceGroupName string, namespaceName string) (result NamespaceResource, err error)
- func (client NamespacesClient) GetAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result SharedAccessAuthorizationRuleResource, err error)
- func (client NamespacesClient) GetAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client NamespacesClient) GetAuthorizationRuleResponder(resp *http.Response) (result SharedAccessAuthorizationRuleResource, err error)
- func (client NamespacesClient) GetAuthorizationRuleSender(req *http.Request) (*http.Response, error)
- func (client NamespacesClient) GetPreparer(ctx context.Context, resourceGroupName string, namespaceName string) (*http.Request, error)
- func (client NamespacesClient) GetResponder(resp *http.Response) (result NamespaceResource, err error)
- func (client NamespacesClient) GetSender(req *http.Request) (*http.Response, error)
- func (client NamespacesClient) List(ctx context.Context, resourceGroupName string) (result NamespaceListResultPage, err error)
- func (client NamespacesClient) ListAll(ctx context.Context) (result NamespaceListResultPage, err error)
- func (client NamespacesClient) ListAllComplete(ctx context.Context) (result NamespaceListResultIterator, err error)
- func (client NamespacesClient) ListAllPreparer(ctx context.Context) (*http.Request, error)
- func (client NamespacesClient) ListAllResponder(resp *http.Response) (result NamespaceListResult, err error)
- func (client NamespacesClient) ListAllSender(req *http.Request) (*http.Response, error)
- func (client NamespacesClient) ListAuthorizationRules(ctx context.Context, resourceGroupName string, namespaceName string) (result SharedAccessAuthorizationRuleListResultPage, err error)
- func (client NamespacesClient) ListAuthorizationRulesComplete(ctx context.Context, resourceGroupName string, namespaceName string) (result SharedAccessAuthorizationRuleListResultIterator, err error)
- func (client NamespacesClient) ListAuthorizationRulesPreparer(ctx context.Context, resourceGroupName string, namespaceName string) (*http.Request, error)
- func (client NamespacesClient) ListAuthorizationRulesResponder(resp *http.Response) (result SharedAccessAuthorizationRuleListResult, err error)
- func (client NamespacesClient) ListAuthorizationRulesSender(req *http.Request) (*http.Response, error)
- func (client NamespacesClient) ListComplete(ctx context.Context, resourceGroupName string) (result NamespaceListResultIterator, err error)
- func (client NamespacesClient) ListKeys(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result ResourceListKeys, err error)
- func (client NamespacesClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client NamespacesClient) ListKeysResponder(resp *http.Response) (result ResourceListKeys, err error)
- func (client NamespacesClient) ListKeysSender(req *http.Request) (*http.Response, error)
- func (client NamespacesClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client NamespacesClient) ListResponder(resp *http.Response) (result NamespaceListResult, err error)
- func (client NamespacesClient) ListSender(req *http.Request) (*http.Response, error)
- func (client NamespacesClient) Patch(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result NamespaceResource, err error)
- func (client NamespacesClient) PatchPreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client NamespacesClient) PatchResponder(resp *http.Response) (result NamespaceResource, err error)
- func (client NamespacesClient) PatchSender(req *http.Request) (*http.Response, error)
- func (client NamespacesClient) RegenerateKeys(ctx context.Context, resourceGroupName string, namespaceName string, ...) (result ResourceListKeys, err error)
- func (client NamespacesClient) RegenerateKeysPreparer(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*http.Request, error)
- func (client NamespacesClient) RegenerateKeysResponder(resp *http.Response) (result ResourceListKeys, err error)
- func (client NamespacesClient) RegenerateKeysSender(req *http.Request) (*http.Response, error)
- type NamespacesDeleteFuture
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationListResultIterator
- func (iter *OperationListResultIterator) Next() error
- func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter OperationListResultIterator) NotDone() bool
- func (iter OperationListResultIterator) Response() OperationListResult
- func (iter OperationListResultIterator) Value() Operation
- type OperationListResultPage
- func (page *OperationListResultPage) Next() error
- func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page OperationListResultPage) NotDone() bool
- func (page OperationListResultPage) Response() OperationListResult
- func (page OperationListResultPage) Values() []Operation
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type PatchParameters
- type PnsCredentialsProperties
- type PnsCredentialsResource
- type PolicykeyResource
- type Properties
- type Resource
- type ResourceListKeys
- type ResourceType
- type SharedAccessAuthorizationRuleCreateOrUpdateParameters
- type SharedAccessAuthorizationRuleListResult
- type SharedAccessAuthorizationRuleListResultIterator
- func (iter *SharedAccessAuthorizationRuleListResultIterator) Next() error
- func (iter *SharedAccessAuthorizationRuleListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter SharedAccessAuthorizationRuleListResultIterator) NotDone() bool
- func (iter SharedAccessAuthorizationRuleListResultIterator) Response() SharedAccessAuthorizationRuleListResult
- func (iter SharedAccessAuthorizationRuleListResultIterator) Value() SharedAccessAuthorizationRuleResource
- type SharedAccessAuthorizationRuleListResultPage
- func (page *SharedAccessAuthorizationRuleListResultPage) Next() error
- func (page *SharedAccessAuthorizationRuleListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page SharedAccessAuthorizationRuleListResultPage) NotDone() bool
- func (page SharedAccessAuthorizationRuleListResultPage) Response() SharedAccessAuthorizationRuleListResult
- func (page SharedAccessAuthorizationRuleListResultPage) Values() []SharedAccessAuthorizationRuleResource
- type SharedAccessAuthorizationRuleProperties
- type SharedAccessAuthorizationRuleResource
- type Sku
- type SkuName
- type SubResource
- type WnsCredential
- type WnsCredentialProperties
Constants ¶
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 ( // AccessRightsListen ... AccessRightsListen AccessRights = "Listen" // AccessRightsManage ... AccessRightsManage AccessRights = "Manage" // AccessRightsSend ... AccessRightsSend AccessRights = "Send" )
func PossibleAccessRightsValues ¶
func PossibleAccessRightsValues() []AccessRights
PossibleAccessRightsValues returns an array of possible values for the AccessRights const type.
type AdmCredential ¶
type AdmCredential struct { // AdmCredentialProperties - Properties of NotificationHub AdmCredential. *AdmCredentialProperties `json:"properties,omitempty"` }
AdmCredential description of a NotificationHub AdmCredential.
func (AdmCredential) MarshalJSON ¶
func (ac AdmCredential) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AdmCredential.
func (*AdmCredential) UnmarshalJSON ¶
func (ac *AdmCredential) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AdmCredential struct.
type AdmCredentialProperties ¶
type AdmCredentialProperties struct { // ClientID - The client identifier. ClientID *string `json:"clientId,omitempty"` // ClientSecret - The credential secret access key. ClientSecret *string `json:"clientSecret,omitempty"` // AuthTokenURL - The URL of the authorization token. AuthTokenURL *string `json:"authTokenUrl,omitempty"` }
AdmCredentialProperties description of a NotificationHub AdmCredential.
type ApnsCredential ¶
type ApnsCredential struct { // ApnsCredentialProperties - Properties of NotificationHub ApnsCredential. *ApnsCredentialProperties `json:"properties,omitempty"` }
ApnsCredential description of a NotificationHub ApnsCredential.
func (ApnsCredential) MarshalJSON ¶
func (ac ApnsCredential) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApnsCredential.
func (*ApnsCredential) UnmarshalJSON ¶
func (ac *ApnsCredential) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApnsCredential struct.
type ApnsCredentialProperties ¶
type ApnsCredentialProperties struct { // ApnsCertificate - The APNS certificate. Specify if using Certificate Authentication Mode. ApnsCertificate *string `json:"apnsCertificate,omitempty"` // CertificateKey - The APNS certificate password if it exists. CertificateKey *string `json:"certificateKey,omitempty"` // Endpoint - The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox specify 'gateway.sandbox.push.apple.com'. If using Certificate Authentication Mode and Production specify 'gateway.push.apple.com'. If using Token Authentication Mode and Sandbox specify 'https://api.development.push.apple.com:443/3/device'. If using Token Authentication Mode and Production specify 'https://api.push.apple.com:443/3/device'. Endpoint *string `json:"endpoint,omitempty"` // Thumbprint - The APNS certificate thumbprint. Specify if using Certificate Authentication Mode. Thumbprint *string `json:"thumbprint,omitempty"` // KeyID - A 10-character key identifier (kid) key, obtained from your developer account. Specify if using Token Authentication Mode. KeyID *string `json:"keyId,omitempty"` // AppName - The name of the application or BundleId. Specify if using Token Authentication Mode. AppName *string `json:"appName,omitempty"` // AppID - The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your developer account. Specify if using Token Authentication Mode. AppID *string `json:"appId,omitempty"` // Token - Provider Authentication Token, obtained through your developer account. Specify if using Token Authentication Mode. Token *string `json:"token,omitempty"` }
ApnsCredentialProperties description of a NotificationHub ApnsCredential. Note that there is no explicit switch between Certificate and Token Authentication Modes. The mode is determined based on the properties passed in.
type BaiduCredential ¶
type BaiduCredential struct { // BaiduCredentialProperties - Properties of NotificationHub BaiduCredential. *BaiduCredentialProperties `json:"properties,omitempty"` }
BaiduCredential description of a NotificationHub BaiduCredential.
func (BaiduCredential) MarshalJSON ¶
func (bc BaiduCredential) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for BaiduCredential.
func (*BaiduCredential) UnmarshalJSON ¶
func (bc *BaiduCredential) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for BaiduCredential struct.
type BaiduCredentialProperties ¶
type BaiduCredentialProperties struct { // BaiduAPIKey - Baidu Api Key. BaiduAPIKey *string `json:"baiduApiKey,omitempty"` // BaiduEndPoint - Baidu Endpoint. BaiduEndPoint *string `json:"baiduEndPoint,omitempty"` // BaiduSecretKey - Baidu Secret Key BaiduSecretKey *string `json:"baiduSecretKey,omitempty"` }
BaiduCredentialProperties description of a NotificationHub BaiduCredential.
type BaseClient ¶
BaseClient is the base client for Notificationhubs.
func New ¶
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type CheckAvailabilityParameters ¶
type CheckAvailabilityParameters struct { // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Name - Resource name Name *string `json:"name,omitempty"` // Type - READ-ONLY; Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Resource tags Tags map[string]*string `json:"tags"` // Sku - The sku of the created namespace Sku *Sku `json:"sku,omitempty"` // IsAvailiable - True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. IsAvailiable *bool `json:"isAvailiable,omitempty"` }
CheckAvailabilityParameters parameters supplied to the Check Name Availability for Namespace and NotificationHubs.
func (CheckAvailabilityParameters) MarshalJSON ¶
func (capVar CheckAvailabilityParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CheckAvailabilityParameters.
type CheckAvailabilityResult ¶
type CheckAvailabilityResult struct { autorest.Response `json:"-"` // IsAvailiable - True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. IsAvailiable *bool `json:"isAvailiable,omitempty"` // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Name - READ-ONLY; Resource name Name *string `json:"name,omitempty"` // Type - READ-ONLY; Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Resource tags Tags map[string]*string `json:"tags"` // Sku - The sku of the created namespace Sku *Sku `json:"sku,omitempty"` }
CheckAvailabilityResult description of a CheckAvailability resource.
func (CheckAvailabilityResult) MarshalJSON ¶
func (car CheckAvailabilityResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CheckAvailabilityResult.
type Client ¶
type Client struct {
BaseClient
}
Client is the azure NotificationHub client
func NewClientWithBaseURI ¶
NewClientWithBaseURI creates an instance of the Client client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (Client) CheckNotificationHubAvailability ¶
func (client Client) CheckNotificationHubAvailability(ctx context.Context, resourceGroupName string, namespaceName string, parameters CheckAvailabilityParameters) (result CheckAvailabilityResult, err error)
CheckNotificationHubAvailability checks the availability of the given notificationHub in a namespace. Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. parameters - the notificationHub name.
func (Client) CheckNotificationHubAvailabilityPreparer ¶
func (client Client) CheckNotificationHubAvailabilityPreparer(ctx context.Context, resourceGroupName string, namespaceName string, parameters CheckAvailabilityParameters) (*http.Request, error)
CheckNotificationHubAvailabilityPreparer prepares the CheckNotificationHubAvailability request.
func (Client) CheckNotificationHubAvailabilityResponder ¶
func (client Client) CheckNotificationHubAvailabilityResponder(resp *http.Response) (result CheckAvailabilityResult, err error)
CheckNotificationHubAvailabilityResponder handles the response to the CheckNotificationHubAvailability request. The method always closes the http.Response Body.
func (Client) CheckNotificationHubAvailabilitySender ¶
func (client Client) CheckNotificationHubAvailabilitySender(req *http.Request) (*http.Response, error)
CheckNotificationHubAvailabilitySender sends the CheckNotificationHubAvailability request. The method will close the http.Response Body if it receives an error.
func (Client) CreateOrUpdate ¶
func (client Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, parameters CreateOrUpdateParameters) (result ResourceType, err error)
CreateOrUpdate creates/Update a NotificationHub in a namespace. Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. notificationHubName - the notification hub name. parameters - parameters supplied to the create/update a NotificationHub Resource.
func (Client) CreateOrUpdateAuthorizationRule ¶
func (client Client) CreateOrUpdateAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string, parameters SharedAccessAuthorizationRuleCreateOrUpdateParameters) (result SharedAccessAuthorizationRuleResource, err error)
CreateOrUpdateAuthorizationRule creates/Updates an authorization rule for a NotificationHub Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. notificationHubName - the notification hub name. authorizationRuleName - authorization Rule Name. parameters - the shared access authorization rule.
func (Client) CreateOrUpdateAuthorizationRulePreparer ¶
func (client Client) CreateOrUpdateAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string, parameters SharedAccessAuthorizationRuleCreateOrUpdateParameters) (*http.Request, error)
CreateOrUpdateAuthorizationRulePreparer prepares the CreateOrUpdateAuthorizationRule request.
func (Client) CreateOrUpdateAuthorizationRuleResponder ¶
func (client Client) 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 (Client) CreateOrUpdateAuthorizationRuleSender ¶
func (client Client) 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 (Client) CreateOrUpdatePreparer ¶
func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, parameters CreateOrUpdateParameters) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (Client) CreateOrUpdateResponder ¶
func (client Client) 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 (Client) CreateOrUpdateSender ¶
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (Client) DebugSend ¶
func (client Client) DebugSend(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, parameters *interface{}) (result DebugSendResponse, err error)
DebugSend test send a push notification Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. notificationHubName - the notification hub name. parameters - debug send parameters
func (Client) DebugSendPreparer ¶
func (client Client) DebugSendPreparer(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, parameters *interface{}) (*http.Request, error)
DebugSendPreparer prepares the DebugSend request.
func (Client) DebugSendResponder ¶
func (client Client) DebugSendResponder(resp *http.Response) (result DebugSendResponse, err error)
DebugSendResponder handles the response to the DebugSend request. The method always closes the http.Response Body.
func (Client) DebugSendSender ¶
DebugSendSender sends the DebugSend request. The method will close the http.Response Body if it receives an error.
func (Client) Delete ¶
func (client Client) Delete(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string) (result autorest.Response, err error)
Delete deletes a notification hub associated with a namespace. Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. notificationHubName - the notification hub name.
func (Client) DeleteAuthorizationRule ¶
func (client Client) DeleteAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string) (result autorest.Response, err error)
DeleteAuthorizationRule deletes a notificationHub authorization rule Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. notificationHubName - the notification hub name. authorizationRuleName - authorization Rule Name.
func (Client) DeleteAuthorizationRulePreparer ¶
func (client Client) DeleteAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string) (*http.Request, error)
DeleteAuthorizationRulePreparer prepares the DeleteAuthorizationRule request.
func (Client) DeleteAuthorizationRuleResponder ¶
func (client Client) 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 (Client) DeleteAuthorizationRuleSender ¶
DeleteAuthorizationRuleSender sends the DeleteAuthorizationRule request. The method will close the http.Response Body if it receives an error.
func (Client) DeletePreparer ¶
func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (Client) DeleteResponder ¶
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (Client) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (Client) Get ¶
func (client Client) Get(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string) (result ResourceType, err error)
Get lists the notification hubs associated with a namespace. Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. notificationHubName - the notification hub name.
func (Client) GetAuthorizationRule ¶
func (client Client) GetAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string) (result SharedAccessAuthorizationRuleResource, err error)
GetAuthorizationRule gets an authorization rule for a NotificationHub by name. Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name notificationHubName - the notification hub name. authorizationRuleName - authorization rule name.
func (Client) GetAuthorizationRulePreparer ¶
func (client Client) GetAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string) (*http.Request, error)
GetAuthorizationRulePreparer prepares the GetAuthorizationRule request.
func (Client) GetAuthorizationRuleResponder ¶
func (client Client) 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 (Client) GetAuthorizationRuleSender ¶
GetAuthorizationRuleSender sends the GetAuthorizationRule request. The method will close the http.Response Body if it receives an error.
func (Client) GetPnsCredentials ¶
func (client Client) GetPnsCredentials(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string) (result PnsCredentialsResource, err error)
GetPnsCredentials lists the PNS Credentials associated with a notification hub . Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. notificationHubName - the notification hub name.
func (Client) GetPnsCredentialsPreparer ¶
func (client Client) GetPnsCredentialsPreparer(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string) (*http.Request, error)
GetPnsCredentialsPreparer prepares the GetPnsCredentials request.
func (Client) GetPnsCredentialsResponder ¶
func (client Client) 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 (Client) GetPnsCredentialsSender ¶
GetPnsCredentialsSender sends the GetPnsCredentials request. The method will close the http.Response Body if it receives an error.
func (Client) GetPreparer ¶
func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (Client) GetResponder ¶
func (client Client) 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 (Client) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (Client) List ¶
func (client Client) List(ctx context.Context, resourceGroupName string, namespaceName string) (result ListResultPage, err error)
List lists the notification hubs associated with a namespace. Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name.
func (Client) ListAuthorizationRules ¶
func (client Client) ListAuthorizationRules(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string) (result SharedAccessAuthorizationRuleListResultPage, err error)
ListAuthorizationRules gets the authorization rules for a NotificationHub. Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name notificationHubName - the notification hub name.
func (Client) ListAuthorizationRulesComplete ¶
func (client Client) ListAuthorizationRulesComplete(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string) (result SharedAccessAuthorizationRuleListResultIterator, err error)
ListAuthorizationRulesComplete enumerates all values, automatically crossing page boundaries as required.
func (Client) ListAuthorizationRulesPreparer ¶
func (client Client) ListAuthorizationRulesPreparer(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string) (*http.Request, error)
ListAuthorizationRulesPreparer prepares the ListAuthorizationRules request.
func (Client) ListAuthorizationRulesResponder ¶
func (client Client) 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 (Client) ListAuthorizationRulesSender ¶
ListAuthorizationRulesSender sends the ListAuthorizationRules request. The method will close the http.Response Body if it receives an error.
func (Client) ListComplete ¶
func (client Client) ListComplete(ctx context.Context, resourceGroupName string, namespaceName string) (result ListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (Client) ListKeys ¶
func (client Client) ListKeys(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string) (result ResourceListKeys, err error)
ListKeys gets the Primary and Secondary ConnectionStrings to the NotificationHub Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. notificationHubName - the notification hub name. authorizationRuleName - the connection string of the NotificationHub for the specified authorizationRule.
func (Client) ListKeysPreparer ¶
func (client Client) ListKeysPreparer(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string) (*http.Request, error)
ListKeysPreparer prepares the ListKeys request.
func (Client) ListKeysResponder ¶
func (client Client) 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 (Client) ListKeysSender ¶
ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.
func (Client) ListPreparer ¶
func (client Client) ListPreparer(ctx context.Context, resourceGroupName string, namespaceName string) (*http.Request, error)
ListPreparer prepares the List request.
func (Client) ListResponder ¶
func (client Client) 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 (Client) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (Client) Patch ¶
func (client Client) Patch(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, parameters *PatchParameters) (result ResourceType, err error)
Patch patch a NotificationHub in a namespace. Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. notificationHubName - the notification hub name. parameters - parameters supplied to patch a NotificationHub Resource.
func (Client) PatchPreparer ¶
func (client Client) PatchPreparer(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, parameters *PatchParameters) (*http.Request, error)
PatchPreparer prepares the Patch request.
func (Client) PatchResponder ¶
func (client Client) PatchResponder(resp *http.Response) (result ResourceType, err error)
PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.
func (Client) PatchSender ¶
PatchSender sends the Patch request. The method will close the http.Response Body if it receives an error.
func (Client) RegenerateKeys ¶
func (client Client) RegenerateKeys(ctx context.Context, 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 Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. notificationHubName - the notification hub name. authorizationRuleName - the connection string of the NotificationHub for the specified authorizationRule. parameters - parameters supplied to regenerate the NotificationHub Authorization Rule Key.
func (Client) RegenerateKeysPreparer ¶
func (client Client) RegenerateKeysPreparer(ctx context.Context, resourceGroupName string, namespaceName string, notificationHubName string, authorizationRuleName string, parameters PolicykeyResource) (*http.Request, error)
RegenerateKeysPreparer prepares the RegenerateKeys request.
func (Client) RegenerateKeysResponder ¶
func (client Client) RegenerateKeysResponder(resp *http.Response) (result ResourceListKeys, err error)
RegenerateKeysResponder handles the response to the RegenerateKeys request. The method always closes the http.Response Body.
type CreateOrUpdateParameters ¶
type CreateOrUpdateParameters struct { // Properties - Properties of the NotificationHub. *Properties `json:"properties,omitempty"` // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Name - READ-ONLY; Resource name Name *string `json:"name,omitempty"` // Type - READ-ONLY; Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Resource tags Tags map[string]*string `json:"tags"` // Sku - The sku of the created namespace Sku *Sku `json:"sku,omitempty"` }
CreateOrUpdateParameters parameters supplied to the CreateOrUpdate NotificationHub operation.
func (CreateOrUpdateParameters) MarshalJSON ¶
func (coup CreateOrUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreateOrUpdateParameters.
func (*CreateOrUpdateParameters) UnmarshalJSON ¶
func (coup *CreateOrUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CreateOrUpdateParameters struct.
type DebugSendResponse ¶
type DebugSendResponse struct { autorest.Response `json:"-"` // DebugSendResult - Properties of the NotificationHub. *DebugSendResult `json:"properties,omitempty"` // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Name - READ-ONLY; Resource name Name *string `json:"name,omitempty"` // Type - READ-ONLY; Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Resource tags Tags map[string]*string `json:"tags"` // Sku - The sku of the created namespace Sku *Sku `json:"sku,omitempty"` }
DebugSendResponse description of a NotificationHub Resource.
func (DebugSendResponse) MarshalJSON ¶
func (dsr DebugSendResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DebugSendResponse.
func (*DebugSendResponse) UnmarshalJSON ¶
func (dsr *DebugSendResponse) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DebugSendResponse struct.
type DebugSendResult ¶
type DebugSendResult struct { // Success - successful send Success *float64 `json:"success,omitempty"` // Failure - send failure Failure *float64 `json:"failure,omitempty"` // Results - actual failure description Results interface{} `json:"results,omitempty"` }
DebugSendResult ...
type ErrorResponse ¶
type ErrorResponse struct { // Code - Error code. Code *string `json:"code,omitempty"` // Message - Error message indicating why the operation failed. Message *string `json:"message,omitempty"` }
ErrorResponse error response indicates NotificationHubs service is not able to process the incoming request. The reason is provided in the error message.
type GcmCredential ¶
type GcmCredential struct { // GcmCredentialProperties - Properties of NotificationHub GcmCredential. *GcmCredentialProperties `json:"properties,omitempty"` }
GcmCredential description of a NotificationHub GcmCredential.
func (GcmCredential) MarshalJSON ¶
func (gc GcmCredential) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GcmCredential.
func (*GcmCredential) UnmarshalJSON ¶
func (gc *GcmCredential) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GcmCredential struct.
type GcmCredentialProperties ¶
type GcmCredentialProperties struct { // GcmEndpoint - The FCM legacy endpoint. Default value is 'https://fcm.googleapis.com/fcm/send' GcmEndpoint *string `json:"gcmEndpoint,omitempty"` // GoogleAPIKey - The Google API key. GoogleAPIKey *string `json:"googleApiKey,omitempty"` }
GcmCredentialProperties description of a NotificationHub GcmCredential.
type ListResult ¶
type ListResult struct { autorest.Response `json:"-"` // Value - Result of the List NotificationHub operation. Value *[]ResourceType `json:"value,omitempty"` // NextLink - Link to the next set of results. Not empty if Value contains incomplete list of NotificationHub NextLink *string `json:"nextLink,omitempty"` }
ListResult the response of the List NotificationHub operation.
func (ListResult) IsEmpty ¶
func (lr ListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ListResultIterator ¶
type ListResultIterator struct {
// contains filtered or unexported fields
}
ListResultIterator provides access to a complete listing of ResourceType values.
func NewListResultIterator ¶
func NewListResultIterator(page ListResultPage) ListResultIterator
Creates a new instance of the ListResultIterator type.
func (*ListResultIterator) Next ¶
func (iter *ListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*ListResultIterator) NextWithContext ¶
func (iter *ListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (ListResultIterator) NotDone ¶
func (iter ListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (ListResultIterator) Response ¶
func (iter ListResultIterator) Response() ListResult
Response returns the raw server response from the last page request.
func (ListResultIterator) Value ¶
func (iter ListResultIterator) Value() ResourceType
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ListResultPage ¶
type ListResultPage struct {
// contains filtered or unexported fields
}
ListResultPage contains a page of ResourceType values.
func NewListResultPage ¶
func NewListResultPage(cur ListResult, getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage
Creates a new instance of the ListResultPage type.
func (*ListResultPage) Next ¶
func (page *ListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*ListResultPage) NextWithContext ¶
func (page *ListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (ListResultPage) NotDone ¶
func (page ListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (ListResultPage) Response ¶
func (page ListResultPage) Response() ListResult
Response returns the raw server response from the last page request.
func (ListResultPage) Values ¶
func (page ListResultPage) Values() []ResourceType
Values returns the slice of values for the current page or nil if there are no values.
type MpnsCredential ¶
type MpnsCredential struct { // MpnsCredentialProperties - Properties of NotificationHub MpnsCredential. *MpnsCredentialProperties `json:"properties,omitempty"` }
MpnsCredential description of a NotificationHub MpnsCredential.
func (MpnsCredential) MarshalJSON ¶
func (mc MpnsCredential) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MpnsCredential.
func (*MpnsCredential) UnmarshalJSON ¶
func (mc *MpnsCredential) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for MpnsCredential struct.
type MpnsCredentialProperties ¶
type MpnsCredentialProperties struct { // MpnsCertificate - The MPNS certificate. MpnsCertificate *string `json:"mpnsCertificate,omitempty"` // CertificateKey - The certificate key for this credential. CertificateKey *string `json:"certificateKey,omitempty"` // Thumbprint - The MPNS certificate Thumbprint Thumbprint *string `json:"thumbprint,omitempty"` }
MpnsCredentialProperties description of a NotificationHub MpnsCredential.
type NamespaceCreateOrUpdateParameters ¶
type NamespaceCreateOrUpdateParameters struct { // NamespaceProperties - Properties of the Namespace. *NamespaceProperties `json:"properties,omitempty"` // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Name - READ-ONLY; Resource name Name *string `json:"name,omitempty"` // Type - READ-ONLY; Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Resource tags Tags map[string]*string `json:"tags"` // Sku - The sku of the created namespace Sku *Sku `json:"sku,omitempty"` }
NamespaceCreateOrUpdateParameters parameters supplied to the CreateOrUpdate Namespace operation.
func (NamespaceCreateOrUpdateParameters) MarshalJSON ¶
func (ncoup NamespaceCreateOrUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NamespaceCreateOrUpdateParameters.
func (*NamespaceCreateOrUpdateParameters) UnmarshalJSON ¶
func (ncoup *NamespaceCreateOrUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for NamespaceCreateOrUpdateParameters struct.
type NamespaceListResult ¶
type NamespaceListResult struct { autorest.Response `json:"-"` // Value - Result of the List Namespace operation. Value *[]NamespaceResource `json:"value,omitempty"` // NextLink - Link to the next set of results. Not empty if Value contains incomplete list of Namespaces NextLink *string `json:"nextLink,omitempty"` }
NamespaceListResult the response of the List Namespace operation.
func (NamespaceListResult) IsEmpty ¶
func (nlr NamespaceListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type NamespaceListResultIterator ¶
type NamespaceListResultIterator struct {
// contains filtered or unexported fields
}
NamespaceListResultIterator provides access to a complete listing of NamespaceResource values.
func NewNamespaceListResultIterator ¶
func NewNamespaceListResultIterator(page NamespaceListResultPage) NamespaceListResultIterator
Creates a new instance of the NamespaceListResultIterator type.
func (*NamespaceListResultIterator) Next ¶
func (iter *NamespaceListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*NamespaceListResultIterator) NextWithContext ¶
func (iter *NamespaceListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (NamespaceListResultIterator) NotDone ¶
func (iter NamespaceListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (NamespaceListResultIterator) Response ¶
func (iter NamespaceListResultIterator) Response() NamespaceListResult
Response returns the raw server response from the last page request.
func (NamespaceListResultIterator) Value ¶
func (iter NamespaceListResultIterator) Value() NamespaceResource
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type NamespaceListResultPage ¶
type NamespaceListResultPage struct {
// contains filtered or unexported fields
}
NamespaceListResultPage contains a page of NamespaceResource values.
func NewNamespaceListResultPage ¶
func NewNamespaceListResultPage(cur NamespaceListResult, getNextPage func(context.Context, NamespaceListResult) (NamespaceListResult, error)) NamespaceListResultPage
Creates a new instance of the NamespaceListResultPage type.
func (*NamespaceListResultPage) Next ¶
func (page *NamespaceListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*NamespaceListResultPage) NextWithContext ¶
func (page *NamespaceListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (NamespaceListResultPage) NotDone ¶
func (page NamespaceListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (NamespaceListResultPage) Response ¶
func (page NamespaceListResultPage) Response() NamespaceListResult
Response returns the raw server response from the last page request.
func (NamespaceListResultPage) Values ¶
func (page NamespaceListResultPage) Values() []NamespaceResource
Values returns the slice of values for the current page or nil if there are no values.
type NamespacePatchParameters ¶
type NamespacePatchParameters struct { // Tags - Resource tags Tags map[string]*string `json:"tags"` // Sku - The sku of the created namespace Sku *Sku `json:"sku,omitempty"` }
NamespacePatchParameters parameters supplied to the Patch Namespace operation.
func (NamespacePatchParameters) MarshalJSON ¶
func (npp NamespacePatchParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NamespacePatchParameters.
type NamespaceProperties ¶
type NamespaceProperties struct { // Name - The name of the namespace. Name *string `json:"name,omitempty"` // ProvisioningState - Provisioning state of the Namespace. ProvisioningState *string `json:"provisioningState,omitempty"` // Region - Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe Region *string `json:"region,omitempty"` // MetricID - READ-ONLY; Identifier for Azure Insights metrics MetricID *string `json:"metricId,omitempty"` // Status - Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting Status *string `json:"status,omitempty"` // CreatedAt - The time the namespace was created. CreatedAt *date.Time `json:"createdAt,omitempty"` // UpdatedAt - The time the namespace was updated. UpdatedAt *date.Time `json:"updatedAt,omitempty"` // ServiceBusEndpoint - Endpoint you can use to perform NotificationHub operations. ServiceBusEndpoint *string `json:"serviceBusEndpoint,omitempty"` // SubscriptionID - The Id of the Azure subscription associated with the namespace. SubscriptionID *string `json:"subscriptionId,omitempty"` // ScaleUnit - ScaleUnit where the namespace gets created ScaleUnit *string `json:"scaleUnit,omitempty"` // Enabled - Whether or not the namespace is currently enabled. Enabled *bool `json:"enabled,omitempty"` // Critical - Whether or not the namespace is set as Critical. Critical *bool `json:"critical,omitempty"` // DataCenter - Data center for the namespace DataCenter *string `json:"dataCenter,omitempty"` // NamespaceType - The namespace type. Possible values include: 'NamespaceTypeMessaging', 'NamespaceTypeNotificationHub' NamespaceType NamespaceType `json:"namespaceType,omitempty"` }
NamespaceProperties namespace properties.
func (NamespaceProperties) MarshalJSON ¶
func (np NamespaceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NamespaceProperties.
type NamespaceResource ¶
type NamespaceResource struct { autorest.Response `json:"-"` // NamespaceProperties - Properties of the Namespace. *NamespaceProperties `json:"properties,omitempty"` // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Name - READ-ONLY; Resource name Name *string `json:"name,omitempty"` // Type - READ-ONLY; Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Resource tags Tags map[string]*string `json:"tags"` // Sku - The sku of the created namespace Sku *Sku `json:"sku,omitempty"` }
NamespaceResource description of a Namespace resource.
func (NamespaceResource) MarshalJSON ¶
func (nr NamespaceResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NamespaceResource.
func (*NamespaceResource) UnmarshalJSON ¶
func (nr *NamespaceResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for NamespaceResource struct.
type NamespaceType ¶
type NamespaceType string
NamespaceType enumerates the values for namespace type.
const ( // NamespaceTypeMessaging ... NamespaceTypeMessaging NamespaceType = "Messaging" // NamespaceTypeNotificationHub ... NamespaceTypeNotificationHub NamespaceType = "NotificationHub" )
func PossibleNamespaceTypeValues ¶
func PossibleNamespaceTypeValues() []NamespaceType
PossibleNamespaceTypeValues returns an array of possible values for the NamespaceType const type.
type NamespacesClient ¶
type NamespacesClient struct {
BaseClient
}
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (NamespacesClient) CheckAvailability ¶
func (client NamespacesClient) CheckAvailability(ctx context.Context, 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: parameters - the namespace name.
func (NamespacesClient) CheckAvailabilityPreparer ¶
func (client NamespacesClient) CheckAvailabilityPreparer(ctx context.Context, 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 ¶
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(ctx context.Context, 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. Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. parameters - parameters supplied to create a Namespace Resource.
func (NamespacesClient) CreateOrUpdateAuthorizationRule ¶
func (client NamespacesClient) CreateOrUpdateAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string, parameters SharedAccessAuthorizationRuleCreateOrUpdateParameters) (result SharedAccessAuthorizationRuleResource, err error)
CreateOrUpdateAuthorizationRule creates an authorization rule for a namespace Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. authorizationRuleName - authorization Rule Name. parameters - the shared access authorization rule.
func (NamespacesClient) CreateOrUpdateAuthorizationRulePreparer ¶
func (client NamespacesClient) CreateOrUpdateAuthorizationRulePreparer(ctx context.Context, 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(ctx context.Context, 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 ¶
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(ctx context.Context, resourceGroupName string, namespaceName string) (result NamespacesDeleteFuture, err error)
Delete deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace. Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name.
func (NamespacesClient) DeleteAuthorizationRule ¶
func (client NamespacesClient) DeleteAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string) (result autorest.Response, err error)
DeleteAuthorizationRule deletes a namespace authorization rule Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. authorizationRuleName - authorization Rule Name.
func (NamespacesClient) DeleteAuthorizationRulePreparer ¶
func (client NamespacesClient) DeleteAuthorizationRulePreparer(ctx context.Context, 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(ctx context.Context, resourceGroupName string, namespaceName string) (*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) (future NamespacesDeleteFuture, err 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(ctx context.Context, resourceGroupName string, namespaceName string) (result NamespaceResource, err error)
Get returns the description for the specified namespace. Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name.
func (NamespacesClient) GetAuthorizationRule ¶
func (client NamespacesClient) GetAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string) (result SharedAccessAuthorizationRuleResource, err error)
GetAuthorizationRule gets an authorization rule for a namespace by name. Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name authorizationRuleName - authorization rule name.
func (NamespacesClient) GetAuthorizationRulePreparer ¶
func (client NamespacesClient) GetAuthorizationRulePreparer(ctx context.Context, 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(ctx context.Context, 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 ¶
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(ctx context.Context, resourceGroupName string) (result NamespaceListResultPage, err error)
List lists the available namespaces within a resourceGroup. Parameters: resourceGroupName - 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(ctx context.Context) (result NamespaceListResultPage, err error)
ListAll lists all the available namespaces within the subscription irrespective of the resourceGroups.
func (NamespacesClient) ListAllComplete ¶
func (client NamespacesClient) ListAllComplete(ctx context.Context) (result NamespaceListResultIterator, err error)
ListAllComplete enumerates all values, automatically crossing page boundaries as required.
func (NamespacesClient) ListAllPreparer ¶
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 ¶
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(ctx context.Context, resourceGroupName string, namespaceName string) (result SharedAccessAuthorizationRuleListResultPage, err error)
ListAuthorizationRules gets the authorization rules for a namespace. Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name
func (NamespacesClient) ListAuthorizationRulesComplete ¶
func (client NamespacesClient) ListAuthorizationRulesComplete(ctx context.Context, resourceGroupName string, namespaceName string) (result SharedAccessAuthorizationRuleListResultIterator, err error)
ListAuthorizationRulesComplete enumerates all values, automatically crossing page boundaries as required.
func (NamespacesClient) ListAuthorizationRulesPreparer ¶
func (client NamespacesClient) ListAuthorizationRulesPreparer(ctx context.Context, 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) ListComplete ¶
func (client NamespacesClient) ListComplete(ctx context.Context, resourceGroupName string) (result NamespaceListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (NamespacesClient) ListKeys ¶
func (client NamespacesClient) ListKeys(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string) (result ResourceListKeys, err error)
ListKeys gets the Primary and Secondary ConnectionStrings to the namespace Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. authorizationRuleName - the connection string of the namespace for the specified authorizationRule.
func (NamespacesClient) ListKeysPreparer ¶
func (client NamespacesClient) ListKeysPreparer(ctx context.Context, 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 ¶
ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.
func (NamespacesClient) ListPreparer ¶
func (client NamespacesClient) ListPreparer(ctx context.Context, 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 ¶
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(ctx context.Context, resourceGroupName string, namespaceName string, parameters NamespacePatchParameters) (result NamespaceResource, err error)
Patch patches the existing namespace Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. parameters - parameters supplied to patch a Namespace Resource.
func (NamespacesClient) PatchPreparer ¶
func (client NamespacesClient) PatchPreparer(ctx context.Context, 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 ¶
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(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string, parameters PolicykeyResource) (result ResourceListKeys, err error)
RegenerateKeys regenerates the Primary/Secondary Keys to the Namespace Authorization Rule Parameters: resourceGroupName - the name of the resource group. namespaceName - the namespace name. authorizationRuleName - the connection string of the namespace for the specified authorizationRule. parameters - parameters supplied to regenerate the Namespace Authorization Rule Key.
func (NamespacesClient) RegenerateKeysPreparer ¶
func (client NamespacesClient) RegenerateKeysPreparer(ctx context.Context, 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 ¶
RegenerateKeysSender sends the RegenerateKeys request. The method will close the http.Response Body if it receives an error.
type NamespacesDeleteFuture ¶
type NamespacesDeleteFuture struct { azure.FutureAPI // Result returns the result of the asynchronous operation. // If the operation has not completed it will return an error. Result func(NamespacesClient) (autorest.Response, error) }
NamespacesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*NamespacesDeleteFuture) UnmarshalJSON ¶
func (future *NamespacesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
type Operation ¶
type Operation struct { // Name - READ-ONLY; Operation name: {provider}/{resource}/{operation} Name *string `json:"name,omitempty"` // Display - The object that represents the operation. Display *OperationDisplay `json:"display,omitempty"` }
Operation a NotificationHubs REST API operation
func (Operation) MarshalJSON ¶
MarshalJSON is the custom marshaler for Operation.
type OperationDisplay ¶
type OperationDisplay struct { // Provider - READ-ONLY; Service provider: Microsoft.NotificationHubs Provider *string `json:"provider,omitempty"` // Resource - READ-ONLY; Resource on which the operation is performed: Invoice, etc. Resource *string `json:"resource,omitempty"` // Operation - READ-ONLY; Operation type: Read, write, delete, etc. Operation *string `json:"operation,omitempty"` }
OperationDisplay the object that represents the operation.
func (OperationDisplay) MarshalJSON ¶
func (o OperationDisplay) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationDisplay.
type OperationListResult ¶
type OperationListResult struct { autorest.Response `json:"-"` // Value - READ-ONLY; List of NotificationHubs operations supported by the Microsoft.NotificationHubs resource provider. Value *[]Operation `json:"value,omitempty"` // NextLink - READ-ONLY; URL to get the next set of operation list results if there are any. NextLink *string `json:"nextLink,omitempty"` }
OperationListResult result of the request to list NotificationHubs operations. It contains a list of operations and a URL link to get the next set of results.
func (OperationListResult) IsEmpty ¶
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (OperationListResult) MarshalJSON ¶
func (olr OperationListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationListResult.
type OperationListResultIterator ¶
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
OperationListResultIterator provides access to a complete listing of Operation values.
func NewOperationListResultIterator ¶
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (*OperationListResultIterator) Next ¶
func (iter *OperationListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*OperationListResultIterator) NextWithContext ¶
func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (OperationListResultIterator) NotDone ¶
func (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (OperationListResultIterator) Response ¶
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (OperationListResultIterator) Value ¶
func (iter OperationListResultIterator) Value() Operation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type OperationListResultPage ¶
type OperationListResultPage struct {
// contains filtered or unexported fields
}
OperationListResultPage contains a page of Operation values.
func NewOperationListResultPage ¶
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (*OperationListResultPage) Next ¶
func (page *OperationListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*OperationListResultPage) NextWithContext ¶
func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (OperationListResultPage) NotDone ¶
func (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (OperationListResultPage) Response ¶
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (OperationListResultPage) Values ¶
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
OperationsClient is the azure NotificationHub client
func NewOperationsClient ¶
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI ¶
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all of the available NotificationHubs REST API operations.
func (OperationsClient) ListComplete ¶
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (OperationsClient) ListPreparer ¶
ListPreparer prepares the List request.
func (OperationsClient) ListResponder ¶
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (OperationsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type PatchParameters ¶
type PatchParameters struct { // Properties - Properties of the NotificationHub. *Properties `json:"properties,omitempty"` // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Name - READ-ONLY; Resource name Name *string `json:"name,omitempty"` // Type - READ-ONLY; Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Resource tags Tags map[string]*string `json:"tags"` // Sku - The sku of the created namespace Sku *Sku `json:"sku,omitempty"` }
PatchParameters parameters supplied to the patch NotificationHub operation.
func (PatchParameters) MarshalJSON ¶
func (pp PatchParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PatchParameters.
func (*PatchParameters) UnmarshalJSON ¶
func (pp *PatchParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PatchParameters struct.
type PnsCredentialsProperties ¶
type PnsCredentialsProperties struct { // ApnsCredential - The ApnsCredential of the created NotificationHub ApnsCredential *ApnsCredential `json:"apnsCredential,omitempty"` // WnsCredential - The WnsCredential of the created NotificationHub WnsCredential *WnsCredential `json:"wnsCredential,omitempty"` // GcmCredential - The GcmCredential of the created NotificationHub GcmCredential *GcmCredential `json:"gcmCredential,omitempty"` // MpnsCredential - The MpnsCredential of the created NotificationHub MpnsCredential *MpnsCredential `json:"mpnsCredential,omitempty"` // AdmCredential - The AdmCredential of the created NotificationHub AdmCredential *AdmCredential `json:"admCredential,omitempty"` // BaiduCredential - The BaiduCredential of the created NotificationHub BaiduCredential *BaiduCredential `json:"baiduCredential,omitempty"` }
PnsCredentialsProperties description of a NotificationHub PNS Credentials.
type PnsCredentialsResource ¶
type PnsCredentialsResource struct { autorest.Response `json:"-"` // PnsCredentialsProperties - NotificationHub PNS Credentials. *PnsCredentialsProperties `json:"properties,omitempty"` // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Name - READ-ONLY; Resource name Name *string `json:"name,omitempty"` // Type - READ-ONLY; Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Resource tags Tags map[string]*string `json:"tags"` // Sku - The sku of the created namespace Sku *Sku `json:"sku,omitempty"` }
PnsCredentialsResource description of a NotificationHub PNS Credentials.
func (PnsCredentialsResource) MarshalJSON ¶
func (pcr PnsCredentialsResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PnsCredentialsResource.
func (*PnsCredentialsResource) UnmarshalJSON ¶
func (pcr *PnsCredentialsResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PnsCredentialsResource struct.
type PolicykeyResource ¶
type PolicykeyResource struct { // PolicyKey - Name of the key that has to be regenerated for the Namespace/Notification Hub Authorization Rule. The value can be Primary Key/Secondary Key. PolicyKey *string `json:"policyKey,omitempty"` }
PolicykeyResource namespace/NotificationHub Regenerate Keys
type Properties ¶
type Properties struct { // Name - The NotificationHub name. Name *string `json:"name,omitempty"` // RegistrationTTL - The RegistrationTtl of the created NotificationHub RegistrationTTL *string `json:"registrationTtl,omitempty"` // AuthorizationRules - The AuthorizationRules of the created NotificationHub AuthorizationRules *[]SharedAccessAuthorizationRuleProperties `json:"authorizationRules,omitempty"` // ApnsCredential - The ApnsCredential of the created NotificationHub ApnsCredential *ApnsCredential `json:"apnsCredential,omitempty"` // WnsCredential - The WnsCredential of the created NotificationHub WnsCredential *WnsCredential `json:"wnsCredential,omitempty"` // GcmCredential - The GcmCredential of the created NotificationHub GcmCredential *GcmCredential `json:"gcmCredential,omitempty"` // MpnsCredential - The MpnsCredential of the created NotificationHub MpnsCredential *MpnsCredential `json:"mpnsCredential,omitempty"` // AdmCredential - The AdmCredential of the created NotificationHub AdmCredential *AdmCredential `json:"admCredential,omitempty"` // BaiduCredential - The BaiduCredential of the created NotificationHub BaiduCredential *BaiduCredential `json:"baiduCredential,omitempty"` }
Properties notificationHub properties.
type Resource ¶
type Resource struct { // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Name - READ-ONLY; Resource name Name *string `json:"name,omitempty"` // Type - READ-ONLY; Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Resource tags Tags map[string]*string `json:"tags"` // Sku - The sku of the created namespace Sku *Sku `json:"sku,omitempty"` }
Resource ...
func (Resource) MarshalJSON ¶
MarshalJSON is the custom marshaler for Resource.
type ResourceListKeys ¶
type ResourceListKeys struct { autorest.Response `json:"-"` // PrimaryConnectionString - PrimaryConnectionString of the AuthorizationRule. PrimaryConnectionString *string `json:"primaryConnectionString,omitempty"` // SecondaryConnectionString - SecondaryConnectionString of the created AuthorizationRule SecondaryConnectionString *string `json:"secondaryConnectionString,omitempty"` // PrimaryKey - PrimaryKey of the created AuthorizationRule. PrimaryKey *string `json:"primaryKey,omitempty"` // SecondaryKey - SecondaryKey of the created AuthorizationRule SecondaryKey *string `json:"secondaryKey,omitempty"` // KeyName - KeyName of the created AuthorizationRule KeyName *string `json:"keyName,omitempty"` }
ResourceListKeys namespace/NotificationHub Connection String
type ResourceType ¶
type ResourceType struct { autorest.Response `json:"-"` // Properties - Properties of the NotificationHub. *Properties `json:"properties,omitempty"` // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Name - READ-ONLY; Resource name Name *string `json:"name,omitempty"` // Type - READ-ONLY; Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Resource tags Tags map[string]*string `json:"tags"` // Sku - The sku of the created namespace Sku *Sku `json:"sku,omitempty"` }
ResourceType description of a NotificationHub Resource.
func (ResourceType) MarshalJSON ¶
func (rt ResourceType) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceType.
func (*ResourceType) UnmarshalJSON ¶
func (rt *ResourceType) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ResourceType struct.
type SharedAccessAuthorizationRuleCreateOrUpdateParameters ¶
type SharedAccessAuthorizationRuleCreateOrUpdateParameters struct { SharedAccessAuthorizationRuleProperties `json:"properties,omitempty"` }Properties *
SharedAccessAuthorizationRuleCreateOrUpdateParameters parameters supplied to the CreateOrUpdate Namespace AuthorizationRules.
type SharedAccessAuthorizationRuleListResult ¶
type SharedAccessAuthorizationRuleListResult struct { SharedAccessAuthorizationRuleResource `json:"value,omitempty"` NextLink *string `json:"nextLink,omitempty"` }Value *[]
SharedAccessAuthorizationRuleListResult the response of the List Namespace operation.
func (SharedAccessAuthorizationRuleListResult) IsEmpty ¶
func (saarlr SharedAccessAuthorizationRuleListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type SharedAccessAuthorizationRuleListResultIterator ¶
type SharedAccessAuthorizationRuleListResultIterator struct {
// contains filtered or unexported fields
}
SharedAccessAuthorizationRuleListResultIterator provides access to a complete listing of SharedAccessAuthorizationRuleResource values.
func NewSharedAccessAuthorizationRuleListResultIterator ¶
func NewSharedAccessAuthorizationRuleListResultIterator(page SharedAccessAuthorizationRuleListResultPage) SharedAccessAuthorizationRuleListResultIterator
Creates a new instance of the SharedAccessAuthorizationRuleListResultIterator type.
func (*SharedAccessAuthorizationRuleListResultIterator) Next ¶
func (iter *SharedAccessAuthorizationRuleListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*SharedAccessAuthorizationRuleListResultIterator) NextWithContext ¶
func (iter *SharedAccessAuthorizationRuleListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (SharedAccessAuthorizationRuleListResultIterator) NotDone ¶
func (iter SharedAccessAuthorizationRuleListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (SharedAccessAuthorizationRuleListResultIterator) Response ¶
func (iter SharedAccessAuthorizationRuleListResultIterator) Response() SharedAccessAuthorizationRuleListResult
Response returns the raw server response from the last page request.
func (SharedAccessAuthorizationRuleListResultIterator) Value ¶
func (iter SharedAccessAuthorizationRuleListResultIterator) Value() SharedAccessAuthorizationRuleResource
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type SharedAccessAuthorizationRuleListResultPage ¶
type SharedAccessAuthorizationRuleListResultPage struct {
// contains filtered or unexported fields
}
SharedAccessAuthorizationRuleListResultPage contains a page of SharedAccessAuthorizationRuleResource values.
func NewSharedAccessAuthorizationRuleListResultPage ¶
func NewSharedAccessAuthorizationRuleListResultPage(cur SharedAccessAuthorizationRuleListResult, getNextPage func(context.Context, SharedAccessAuthorizationRuleListResult) (SharedAccessAuthorizationRuleListResult, error)) SharedAccessAuthorizationRuleListResultPage
Creates a new instance of the SharedAccessAuthorizationRuleListResultPage type.
func (*SharedAccessAuthorizationRuleListResultPage) Next ¶
func (page *SharedAccessAuthorizationRuleListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*SharedAccessAuthorizationRuleListResultPage) NextWithContext ¶
func (page *SharedAccessAuthorizationRuleListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (SharedAccessAuthorizationRuleListResultPage) NotDone ¶
func (page SharedAccessAuthorizationRuleListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (SharedAccessAuthorizationRuleListResultPage) Response ¶
func (page SharedAccessAuthorizationRuleListResultPage) Response() SharedAccessAuthorizationRuleListResult
Response returns the raw server response from the last page request.
func (SharedAccessAuthorizationRuleListResultPage) Values ¶
func (page SharedAccessAuthorizationRuleListResultPage) Values() []SharedAccessAuthorizationRuleResource
Values returns the slice of values for the current page or nil if there are no values.
type SharedAccessAuthorizationRuleProperties ¶
type SharedAccessAuthorizationRuleProperties struct { AccessRights `json:"rights,omitempty"` PrimaryKey *string `json:"primaryKey,omitempty"` SecondaryKey *string `json:"secondaryKey,omitempty"` KeyName *string `json:"keyName,omitempty"` ClaimType *string `json:"claimType,omitempty"` ClaimValue *string `json:"claimValue,omitempty"` ModifiedTime *string `json:"modifiedTime,omitempty"` CreatedTime *string `json:"createdTime,omitempty"` Revision *int32 `json:"revision,omitempty"` }Rights *[]
SharedAccessAuthorizationRuleProperties sharedAccessAuthorizationRule properties.
func (SharedAccessAuthorizationRuleProperties) MarshalJSON ¶
func (saarp SharedAccessAuthorizationRuleProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SharedAccessAuthorizationRuleProperties.
type SharedAccessAuthorizationRuleResource ¶
type SharedAccessAuthorizationRuleResource struct { SharedAccessAuthorizationRuleProperties `json:"properties,omitempty"` 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"` Sku *Sku `json:"sku,omitempty"` }*
SharedAccessAuthorizationRuleResource description of a Namespace AuthorizationRules.
func (SharedAccessAuthorizationRuleResource) MarshalJSON ¶
func (saarr SharedAccessAuthorizationRuleResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SharedAccessAuthorizationRuleResource.
func (*SharedAccessAuthorizationRuleResource) UnmarshalJSON ¶
func (saarr *SharedAccessAuthorizationRuleResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SharedAccessAuthorizationRuleResource struct.
type Sku ¶
type Sku struct { // Name - Name of the notification hub sku. Possible values include: 'SkuNameFree', 'SkuNameBasic', 'SkuNameStandard' Name SkuName `json:"name,omitempty"` // Tier - The tier of particular sku Tier *string `json:"tier,omitempty"` // Size - The Sku size Size *string `json:"size,omitempty"` // Family - The Sku Family Family *string `json:"family,omitempty"` // Capacity - The capacity of the resource Capacity *int32 `json:"capacity,omitempty"` }
Sku the Sku description for a namespace
type SkuName ¶
type SkuName string
SkuName enumerates the values for sku name.
func PossibleSkuNameValues ¶
func PossibleSkuNameValues() []SkuName
PossibleSkuNameValues returns an array of possible values for the SkuName const type.
type SubResource ¶
type SubResource struct { // ID - Resource Id ID *string `json:"id,omitempty"` }
SubResource ...
type WnsCredential ¶
type WnsCredential struct { // WnsCredentialProperties - Properties of NotificationHub WnsCredential. *WnsCredentialProperties `json:"properties,omitempty"` }
WnsCredential description of a NotificationHub WnsCredential.
func (WnsCredential) MarshalJSON ¶
func (wc WnsCredential) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for WnsCredential.
func (*WnsCredential) UnmarshalJSON ¶
func (wc *WnsCredential) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for WnsCredential struct.
type WnsCredentialProperties ¶
type WnsCredentialProperties struct { // PackageSid - The package ID for this credential. PackageSid *string `json:"packageSid,omitempty"` // SecretKey - The secret key. SecretKey *string `json:"secretKey,omitempty"` // WindowsLiveEndpoint - The Windows Live endpoint. WindowsLiveEndpoint *string `json:"windowsLiveEndpoint,omitempty"` }
WnsCredentialProperties description of a NotificationHub WnsCredential.