azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/preview/signalr/mgmt/2018-03-01-preview/signalr Index | Files | Directories

package signalr

import "github.com/Azure/azure-sdk-for-go/services/preview/signalr/mgmt/2018-03-01-preview/signalr"

Package signalr implements the Azure ARM Signalr service API version 2018-03-01-preview.

REST API for Azure SignalR Service

Index

Package Files

client.go models.go operations.go signalr.go usages.go version.go

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type BaseClient Uses

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

BaseClient is the base client for Signalr.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type Client Uses

type Client struct {
    BaseClient
}

Client is the REST API for Azure SignalR Service

func NewClient Uses

func NewClient(subscriptionID string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI Uses

func NewClientWithBaseURI(baseURI string, subscriptionID string) Client

NewClientWithBaseURI creates an instance of the Client client.

func (Client) CheckNameAvailability Uses

func (client Client) CheckNameAvailability(ctx context.Context, location string, parameters *NameAvailabilityParameters) (result NameAvailability, err error)

CheckNameAvailability checks that the SignalR name is valid and is not already in use. Parameters: location - the region parameters - parameters supplied to the operation.

func (Client) CheckNameAvailabilityPreparer Uses

func (client Client) CheckNameAvailabilityPreparer(ctx context.Context, location string, parameters *NameAvailabilityParameters) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (Client) CheckNameAvailabilityResponder Uses

func (client Client) CheckNameAvailabilityResponder(resp *http.Response) (result NameAvailability, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (Client) CheckNameAvailabilitySender Uses

func (client Client) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

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

func (Client) CreateOrUpdate Uses

func (client Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, parameters *CreateParameters) (result CreateOrUpdateFuture, err error)

CreateOrUpdate create a new SignalR service and update an exiting SignalR service. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. resourceName - the name of the SignalR resource. parameters - parameters for the create or update operation

func (Client) CreateOrUpdatePreparer Uses

func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, parameters *CreateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (Client) CreateOrUpdateResponder Uses

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 Uses

func (client Client) CreateOrUpdateSender(req *http.Request) (future CreateOrUpdateFuture, err error)

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

func (Client) Delete Uses

func (client Client) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result DeleteFuture, err error)

Delete operation to delete a SignalR service. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. resourceName - the name of the SignalR resource.

func (Client) DeletePreparer Uses

func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (Client) DeleteResponder Uses

func (client Client) 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 (Client) DeleteSender Uses

func (client Client) DeleteSender(req *http.Request) (future DeleteFuture, err error)

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

func (Client) Get Uses

func (client Client) Get(ctx context.Context, resourceGroupName string, resourceName string) (result ResourceType, err error)

Get get the SignalR service and its properties. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. resourceName - the name of the SignalR resource.

func (Client) GetPreparer Uses

func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (Client) GetResponder Uses

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 Uses

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

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

func (Client) ListByResourceGroup Uses

func (client Client) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ResourceListPage, err error)

ListByResourceGroup handles requests to list all resources in a resource group. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

func (Client) ListByResourceGroupComplete Uses

func (client Client) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ResourceListIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListByResourceGroupPreparer Uses

func (client Client) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (Client) ListByResourceGroupResponder Uses

func (client Client) ListByResourceGroupResponder(resp *http.Response) (result ResourceList, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (Client) ListByResourceGroupSender Uses

func (client Client) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (Client) ListBySubscription Uses

func (client Client) ListBySubscription(ctx context.Context) (result ResourceListPage, err error)

ListBySubscription handles requests to list all resources in a subscription.

func (Client) ListBySubscriptionComplete Uses

func (client Client) ListBySubscriptionComplete(ctx context.Context) (result ResourceListIterator, err error)

ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListBySubscriptionPreparer Uses

func (client Client) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (Client) ListBySubscriptionResponder Uses

func (client Client) ListBySubscriptionResponder(resp *http.Response) (result ResourceList, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (Client) ListBySubscriptionSender Uses

func (client Client) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

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

func (Client) ListKeys Uses

func (client Client) ListKeys(ctx context.Context, resourceGroupName string, resourceName string) (result Keys, err error)

ListKeys get the access keys of the SignalR resource. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. resourceName - the name of the SignalR resource.

func (Client) ListKeysPreparer Uses

func (client Client) ListKeysPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (Client) ListKeysResponder Uses

func (client Client) ListKeysResponder(resp *http.Response) (result Keys, err error)

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

func (Client) ListKeysSender Uses

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

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

func (Client) RegenerateKey Uses

func (client Client) RegenerateKey(ctx context.Context, resourceGroupName string, resourceName string, parameters *RegenerateKeyParameters) (result RegenerateKeyFuture, err error)

RegenerateKey regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. resourceName - the name of the SignalR resource. parameters - parameter that describes the Regenerate Key Operation.

func (Client) RegenerateKeyPreparer Uses

func (client Client) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, resourceName string, parameters *RegenerateKeyParameters) (*http.Request, error)

RegenerateKeyPreparer prepares the RegenerateKey request.

func (Client) RegenerateKeyResponder Uses

func (client Client) RegenerateKeyResponder(resp *http.Response) (result Keys, err error)

RegenerateKeyResponder handles the response to the RegenerateKey request. The method always closes the http.Response Body.

func (Client) RegenerateKeySender Uses

func (client Client) RegenerateKeySender(req *http.Request) (future RegenerateKeyFuture, err error)

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

func (Client) Update Uses

func (client Client) Update(ctx context.Context, resourceGroupName string, resourceName string, parameters *UpdateParameters) (result UpdateFuture, err error)

Update operation to update an exiting SignalR service. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. resourceName - the name of the SignalR resource. parameters - parameters for the update operation

func (Client) UpdatePreparer Uses

func (client Client) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, parameters *UpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (Client) UpdateResponder Uses

func (client Client) UpdateResponder(resp *http.Response) (result ResourceType, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (Client) UpdateSender Uses

func (client Client) UpdateSender(req *http.Request) (future UpdateFuture, err error)

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

type CreateOrUpdateFuture Uses

type CreateOrUpdateFuture struct {
    azure.Future
}

CreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CreateOrUpdateFuture) Result Uses

func (future *CreateOrUpdateFuture) Result(client Client) (rt ResourceType, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type CreateOrUpdateProperties Uses

type CreateOrUpdateProperties struct {
    // HostNamePrefix - Prefix for the hostName of the SignalR service. Retained for future use.
    // The hostname will be of format: <hostNamePrefix>.service.signalr.net.
    HostNamePrefix *string `json:"hostNamePrefix,omitempty"`
}

CreateOrUpdateProperties settings used to provision or configure the resource.

type CreateParameters Uses

type CreateParameters struct {
    // Location - Azure GEO region: e.g. West US | East US | North Central US | South Central US | West Europe | North Europe | East Asia | Southeast Asia | etc.
    // The geo region of a resource never changes after it is created.
    Location *string `json:"location,omitempty"`
    // Tags - A list of key value pairs that describe the resource.
    Tags map[string]*string `json:"tags"`
    // Sku - The billing information of the resource.(e.g. basic vs. standard)
    Sku *ResourceSku `json:"sku,omitempty"`
    // Properties - Settings used to provision or configure the resource
    Properties *CreateOrUpdateProperties `json:"properties,omitempty"`
}

CreateParameters parameters for SignalR service create/update operation.

Keep the same schema as AzSignalR.Models.SignalRResource

func (CreateParameters) MarshalJSON Uses

func (cp CreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateParameters.

type DeleteFuture Uses

type DeleteFuture struct {
    azure.Future
}

DeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DeleteFuture) Result Uses

func (future *DeleteFuture) Result(client Client) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type Dimension Uses

type Dimension struct {
    // Name - The public facing name of the dimension.
    Name *string `json:"name,omitempty"`
    // DisplayName - Localized friendly display name of the dimension.
    DisplayName *string `json:"displayName,omitempty"`
    // InternalName - Name of the dimension as it appears in MDM.
    InternalName *string `json:"internalName,omitempty"`
    // ToBeExportedForShoebox - A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.
    ToBeExportedForShoebox *bool `json:"toBeExportedForShoebox,omitempty"`
}

Dimension specifications of the Dimension of metrics.

type KeyType Uses

type KeyType string

KeyType enumerates the values for key type.

const (
    // Primary ...
    Primary KeyType = "Primary"
    // Secondary ...
    Secondary KeyType = "Secondary"
)

func PossibleKeyTypeValues Uses

func PossibleKeyTypeValues() []KeyType

PossibleKeyTypeValues returns an array of possible values for the KeyType const type.

type Keys Uses

type Keys struct {
    autorest.Response `json:"-"`
    // PrimaryKey - The primary access key.
    PrimaryKey *string `json:"primaryKey,omitempty"`
    // SecondaryKey - The secondary access key.
    SecondaryKey *string `json:"secondaryKey,omitempty"`
    // PrimaryConnectionString - SignalR connection string constructed via the primaryKey
    PrimaryConnectionString *string `json:"primaryConnectionString,omitempty"`
    // SecondaryConnectionString - SignalR connection string constructed via the secondaryKey
    SecondaryConnectionString *string `json:"secondaryConnectionString,omitempty"`
}

Keys a class represents the access keys of SignalR service.

type MetricSpecification Uses

type MetricSpecification struct {
    // Name - Name of the metric.
    Name *string `json:"name,omitempty"`
    // DisplayName - Localized friendly display name of the metric.
    DisplayName *string `json:"displayName,omitempty"`
    // DisplayDescription - Localized friendly description of the metric.
    DisplayDescription *string `json:"displayDescription,omitempty"`
    // Unit - The unit that makes sense for the metric.
    Unit *string `json:"unit,omitempty"`
    // AggregationType - Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.
    AggregationType *string `json:"aggregationType,omitempty"`
    // FillGapWithZero - Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published.
    // Ex. a metric that returns the number of times a particular error code was emitted. The error code may not appear
    // often, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.
    FillGapWithZero *string `json:"fillGapWithZero,omitempty"`
    // Category - The name of the metric category that the metric belongs to. A metric can only belong to a single category.
    Category *string `json:"category,omitempty"`
    // Dimensions - The dimensions of the metrics.
    Dimensions *[]Dimension `json:"dimensions,omitempty"`
}

MetricSpecification specifications of the Metrics for Azure Monitoring.

type NameAvailability Uses

type NameAvailability struct {
    autorest.Response `json:"-"`
    // NameAvailable - Indicates whether the name is available or not.
    NameAvailable *bool `json:"nameAvailable,omitempty"`
    // Reason - The reason of the availability. Required if name is not available.
    Reason *string `json:"reason,omitempty"`
    // Message - The message of the operation.
    Message *string `json:"message,omitempty"`
}

NameAvailability result of the request to check name availability. It contains a flag and possible reason of failure.

type NameAvailabilityParameters Uses

type NameAvailabilityParameters struct {
    // Type - The resource type. Should be always "Microsoft.SignalRService/SignalR".
    Type *string `json:"type,omitempty"`
    // Name - The SignalR service name to validate. e.g."my-signalR-name-here"
    Name *string `json:"name,omitempty"`
}

NameAvailabilityParameters data POST-ed to the nameAvailability action

type Operation Uses

type Operation struct {
    // Name - Name of the operation with format: {provider}/{resource}/{operation}
    Name *string `json:"name,omitempty"`
    // Display - The object that describes the operation.
    Display *OperationDisplay `json:"display,omitempty"`
    // Origin - Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.
    Origin *string `json:"origin,omitempty"`
    // Properties - Extra properties for the operation.
    Properties *OperationProperties `json:"properties,omitempty"`
}

Operation REST API operation supported by SignalR resource provider.

type OperationDisplay Uses

type OperationDisplay struct {
    // Provider - Friendly name of the resource provider
    Provider *string `json:"provider,omitempty"`
    // Resource - Resource type on which the operation is performed.
    Resource *string `json:"resource,omitempty"`
    // Operation - The localized friendly name for the operation.
    Operation *string `json:"operation,omitempty"`
    // Description - The localized friendly description for the operation
    Description *string `json:"description,omitempty"`
}

OperationDisplay the object that describes a operation.

type OperationList Uses

type OperationList struct {
    autorest.Response `json:"-"`
    // Value - List of operations supported by the resource provider.
    Value *[]Operation `json:"value,omitempty"`
    // NextLink - The URL the client should use to fetch the next page (per server side paging).
    // It's null for now, added for future use.
    NextLink *string `json:"nextLink,omitempty"`
}

OperationList result of the request to list REST API operations. It contains a list of operations.

func (OperationList) IsEmpty Uses

func (ol OperationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListIterator Uses

type OperationListIterator struct {
    // contains filtered or unexported fields
}

OperationListIterator provides access to a complete listing of Operation values.

func NewOperationListIterator Uses

func NewOperationListIterator(page OperationListPage) OperationListIterator

Creates a new instance of the OperationListIterator type.

func (*OperationListIterator) Next Uses

func (iter *OperationListIterator) 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 (*OperationListIterator) NextWithContext Uses

func (iter *OperationListIterator) 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 (OperationListIterator) NotDone Uses

func (iter OperationListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListIterator) Response Uses

func (iter OperationListIterator) Response() OperationList

Response returns the raw server response from the last page request.

func (OperationListIterator) Value Uses

func (iter OperationListIterator) Value() Operation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListPage Uses

type OperationListPage struct {
    // contains filtered or unexported fields
}

OperationListPage contains a page of Operation values.

func NewOperationListPage Uses

func NewOperationListPage(getNextPage func(context.Context, OperationList) (OperationList, error)) OperationListPage

Creates a new instance of the OperationListPage type.

func (*OperationListPage) Next Uses

func (page *OperationListPage) 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 (*OperationListPage) NextWithContext Uses

func (page *OperationListPage) 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 (OperationListPage) NotDone Uses

func (page OperationListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListPage) Response Uses

func (page OperationListPage) Response() OperationList

Response returns the raw server response from the last page request.

func (OperationListPage) Values Uses

func (page OperationListPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type OperationProperties Uses

type OperationProperties struct {
    // ServiceSpecification - The service specifications.
    ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationProperties extra Operation properties.

type OperationsClient Uses

type OperationsClient struct {
    BaseClient
}

OperationsClient is the REST API for Azure SignalR Service

func NewOperationsClient Uses

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List Uses

func (client OperationsClient) List(ctx context.Context) (result OperationListPage, err error)

List lists all of the available REST API operations of the Microsoft.SignalRService provider.

func (OperationsClient) ListComplete Uses

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer Uses

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationList, err error)

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

func (OperationsClient) ListSender Uses

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

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

type Properties Uses

type Properties struct {
    // ProvisioningState - READ-ONLY; Provisioning state of the resource. Possible values include: 'Unknown', 'Succeeded', 'Failed', 'Canceled', 'Running', 'Creating', 'Updating', 'Deleting', 'Moving'
    ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
    // ExternalIP - READ-ONLY; The publicly accessible IP of the SignalR service.
    ExternalIP *string `json:"externalIP,omitempty"`
    // HostName - READ-ONLY; FQDN of the SignalR service instance. Format: xxx.service.signalr.net
    HostName *string `json:"hostName,omitempty"`
    // PublicPort - READ-ONLY; The publicly accessibly port of the SignalR service which is designed for browser/client side usage.
    PublicPort *int32 `json:"publicPort,omitempty"`
    // ServerPort - READ-ONLY; The publicly accessibly port of the SignalR service which is designed for customer server side usage.
    ServerPort *int32 `json:"serverPort,omitempty"`
    // Version - Version of the SignalR resource. Probably you need the same or higher version of client SDKs.
    Version *string `json:"version,omitempty"`
    // HostNamePrefix - Prefix for the hostName of the SignalR service. Retained for future use.
    // The hostname will be of format: <hostNamePrefix>.service.signalr.net.
    HostNamePrefix *string `json:"hostNamePrefix,omitempty"`
}

Properties a class that describes the properties of the SignalR service that should contain more read-only properties than AzSignalR.Models.SignalRCreateOrUpdateProperties

type ProvisioningState Uses

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

const (
    // Canceled ...
    Canceled ProvisioningState = "Canceled"
    // Creating ...
    Creating ProvisioningState = "Creating"
    // Deleting ...
    Deleting ProvisioningState = "Deleting"
    // Failed ...
    Failed ProvisioningState = "Failed"
    // Moving ...
    Moving ProvisioningState = "Moving"
    // Running ...
    Running ProvisioningState = "Running"
    // Succeeded ...
    Succeeded ProvisioningState = "Succeeded"
    // Unknown ...
    Unknown ProvisioningState = "Unknown"
    // Updating ...
    Updating ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues Uses

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type RegenerateKeyFuture Uses

type RegenerateKeyFuture struct {
    azure.Future
}

RegenerateKeyFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*RegenerateKeyFuture) Result Uses

func (future *RegenerateKeyFuture) Result(client Client) (kVar Keys, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type RegenerateKeyParameters Uses

type RegenerateKeyParameters struct {
    // KeyType - The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive). Possible values include: 'Primary', 'Secondary'
    KeyType KeyType `json:"keyType,omitempty"`
}

RegenerateKeyParameters parameters describes the request to regenerate access keys

type Resource Uses

type Resource struct {
    // ID - READ-ONLY; Fully qualified resource Id for the resource.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the service - e.g. "Microsoft.SignalRService/SignalR"
    Type *string `json:"type,omitempty"`
}

Resource the core properties of ARM resources.

type ResourceList Uses

type ResourceList struct {
    autorest.Response `json:"-"`
    // Value - List of SignalR services
    Value *[]ResourceType `json:"value,omitempty"`
    // NextLink - The URL the client should use to fetch the next page (per server side paging).
    // It's null for now, added for future use.
    NextLink *string `json:"nextLink,omitempty"`
}

ResourceList object that includes an array of SignalR services and a possible link for next set.

func (ResourceList) IsEmpty Uses

func (rl ResourceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ResourceListIterator Uses

type ResourceListIterator struct {
    // contains filtered or unexported fields
}

ResourceListIterator provides access to a complete listing of ResourceType values.

func NewResourceListIterator Uses

func NewResourceListIterator(page ResourceListPage) ResourceListIterator

Creates a new instance of the ResourceListIterator type.

func (*ResourceListIterator) Next Uses

func (iter *ResourceListIterator) 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 (*ResourceListIterator) NextWithContext Uses

func (iter *ResourceListIterator) 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 (ResourceListIterator) NotDone Uses

func (iter ResourceListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ResourceListIterator) Response Uses

func (iter ResourceListIterator) Response() ResourceList

Response returns the raw server response from the last page request.

func (ResourceListIterator) Value Uses

func (iter ResourceListIterator) Value() ResourceType

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ResourceListPage Uses

type ResourceListPage struct {
    // contains filtered or unexported fields
}

ResourceListPage contains a page of ResourceType values.

func NewResourceListPage Uses

func NewResourceListPage(getNextPage func(context.Context, ResourceList) (ResourceList, error)) ResourceListPage

Creates a new instance of the ResourceListPage type.

func (*ResourceListPage) Next Uses

func (page *ResourceListPage) 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 (*ResourceListPage) NextWithContext Uses

func (page *ResourceListPage) 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 (ResourceListPage) NotDone Uses

func (page ResourceListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ResourceListPage) Response Uses

func (page ResourceListPage) Response() ResourceList

Response returns the raw server response from the last page request.

func (ResourceListPage) Values Uses

func (page ResourceListPage) Values() []ResourceType

Values returns the slice of values for the current page or nil if there are no values.

type ResourceSku Uses

type ResourceSku struct {
    // Name - The name of the SKU. This is typically a letter + number code, such as A0 or P3.  Required (if sku is specified)
    Name *string `json:"name,omitempty"`
    // Tier - Optional tier of this particular SKU. `Basic` is deprecated, use `Standard` instead for Basic tier. Possible values include: 'Free', 'Basic', 'Standard', 'Premium'
    Tier SkuTier `json:"tier,omitempty"`
    // Size - Optional, string. When the name field is the combination of tier and some other value, this would be the standalone code.
    Size *string `json:"size,omitempty"`
    // Family - Optional, string. If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Family *string `json:"family,omitempty"`
    // Capacity - Optional, integer. If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not
    // possible for the resource this may be omitted.
    Capacity *int32 `json:"capacity,omitempty"`
}

ResourceSku the billing information of the resource.(e.g. basic vs. standard)

type ResourceType Uses

type ResourceType struct {
    autorest.Response `json:"-"`
    // Sku - SKU of the service.
    Sku *ResourceSku `json:"sku,omitempty"`
    // Properties - The properties of the service.
    *Properties `json:"properties,omitempty"`
    // Location - The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.
    Location *string `json:"location,omitempty"`
    // Tags - Tags of the service which is a list of key value pairs that describe the resource.
    Tags map[string]*string `json:"tags"`
    // ID - READ-ONLY; Fully qualified resource Id for the resource.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the service - e.g. "Microsoft.SignalRService/SignalR"
    Type *string `json:"type,omitempty"`
}

ResourceType a class represent a SignalR service resource.

func (ResourceType) MarshalJSON Uses

func (rt ResourceType) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceType.

func (*ResourceType) UnmarshalJSON Uses

func (rt *ResourceType) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ResourceType struct.

type ServiceSpecification Uses

type ServiceSpecification struct {
    // MetricSpecifications - Specifications of the Metrics for Azure Monitoring.
    MetricSpecifications *[]MetricSpecification `json:"metricSpecifications,omitempty"`
}

ServiceSpecification an object that describes a specification.

type SkuTier Uses

type SkuTier string

SkuTier enumerates the values for sku tier.

const (
    // Basic ...
    Basic SkuTier = "Basic"
    // Free ...
    Free SkuTier = "Free"
    // Premium ...
    Premium SkuTier = "Premium"
    // Standard ...
    Standard SkuTier = "Standard"
)

func PossibleSkuTierValues Uses

func PossibleSkuTierValues() []SkuTier

PossibleSkuTierValues returns an array of possible values for the SkuTier const type.

type TrackedResource Uses

type TrackedResource struct {
    // Location - The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.
    Location *string `json:"location,omitempty"`
    // Tags - Tags of the service which is a list of key value pairs that describe the resource.
    Tags map[string]*string `json:"tags"`
    // ID - READ-ONLY; Fully qualified resource Id for the resource.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the service - e.g. "Microsoft.SignalRService/SignalR"
    Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for a ARM tracked top level resource.

func (TrackedResource) MarshalJSON Uses

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type UpdateFuture Uses

type UpdateFuture struct {
    azure.Future
}

UpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*UpdateFuture) Result Uses

func (future *UpdateFuture) Result(client Client) (rt ResourceType, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type UpdateParameters Uses

type UpdateParameters struct {
    // Tags - A list of key value pairs that describe the resource.
    Tags map[string]*string `json:"tags"`
    // Sku - The billing information of the resource.(e.g. basic vs. standard)
    Sku *ResourceSku `json:"sku,omitempty"`
    // Properties - Settings used to provision or configure the resource
    Properties *CreateOrUpdateProperties `json:"properties,omitempty"`
}

UpdateParameters parameters for SignalR service update operation

func (UpdateParameters) MarshalJSON Uses

func (up UpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UpdateParameters.

type Usage Uses

type Usage struct {
    // ID - Fully qualified ARM resource id
    ID  *string `json:"id,omitempty"`
    // CurrentValue - Current value for the usage quota.
    CurrentValue *int64 `json:"currentValue,omitempty"`
    // Limit - The maximum permitted value for the usage quota. If there is no limit, this value will be -1.
    Limit *int64 `json:"limit,omitempty"`
    // Name - Localizable String object containing the name and a localized value.
    Name *UsageName `json:"name,omitempty"`
    // Unit - Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.
    Unit *string `json:"unit,omitempty"`
}

Usage object that describes a specific usage of SignalR resources.

type UsageList Uses

type UsageList struct {
    autorest.Response `json:"-"`
    // Value - List of SignalR usages
    Value *[]Usage `json:"value,omitempty"`
    // NextLink - The URL the client should use to fetch the next page (per server side paging).
    // It's null for now, added for future use.
    NextLink *string `json:"nextLink,omitempty"`
}

UsageList object that includes an array of SignalR resource usages and a possible link for next set.

func (UsageList) IsEmpty Uses

func (ul UsageList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type UsageListIterator Uses

type UsageListIterator struct {
    // contains filtered or unexported fields
}

UsageListIterator provides access to a complete listing of Usage values.

func NewUsageListIterator Uses

func NewUsageListIterator(page UsageListPage) UsageListIterator

Creates a new instance of the UsageListIterator type.

func (*UsageListIterator) Next Uses

func (iter *UsageListIterator) 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 (*UsageListIterator) NextWithContext Uses

func (iter *UsageListIterator) 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 (UsageListIterator) NotDone Uses

func (iter UsageListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (UsageListIterator) Response Uses

func (iter UsageListIterator) Response() UsageList

Response returns the raw server response from the last page request.

func (UsageListIterator) Value Uses

func (iter UsageListIterator) Value() Usage

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type UsageListPage Uses

type UsageListPage struct {
    // contains filtered or unexported fields
}

UsageListPage contains a page of Usage values.

func NewUsageListPage Uses

func NewUsageListPage(getNextPage func(context.Context, UsageList) (UsageList, error)) UsageListPage

Creates a new instance of the UsageListPage type.

func (*UsageListPage) Next Uses

func (page *UsageListPage) 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 (*UsageListPage) NextWithContext Uses

func (page *UsageListPage) 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 (UsageListPage) NotDone Uses

func (page UsageListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (UsageListPage) Response Uses

func (page UsageListPage) Response() UsageList

Response returns the raw server response from the last page request.

func (UsageListPage) Values Uses

func (page UsageListPage) Values() []Usage

Values returns the slice of values for the current page or nil if there are no values.

type UsageName Uses

type UsageName struct {
    // Value - The identifier of the usage.
    Value *string `json:"value,omitempty"`
    // LocalizedValue - Localized name of the usage.
    LocalizedValue *string `json:"localizedValue,omitempty"`
}

UsageName localizable String object containing the name and a localized value.

type UsagesClient Uses

type UsagesClient struct {
    BaseClient
}

UsagesClient is the REST API for Azure SignalR Service

func NewUsagesClient Uses

func NewUsagesClient(subscriptionID string) UsagesClient

NewUsagesClient creates an instance of the UsagesClient client.

func NewUsagesClientWithBaseURI Uses

func NewUsagesClientWithBaseURI(baseURI string, subscriptionID string) UsagesClient

NewUsagesClientWithBaseURI creates an instance of the UsagesClient client.

func (UsagesClient) List Uses

func (client UsagesClient) List(ctx context.Context, location string) (result UsageListPage, err error)

List list usage quotas for Azure SignalR service by location. Parameters: location - the location like "eastus"

func (UsagesClient) ListComplete Uses

func (client UsagesClient) ListComplete(ctx context.Context, location string) (result UsageListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (UsagesClient) ListPreparer Uses

func (client UsagesClient) ListPreparer(ctx context.Context, location string) (*http.Request, error)

ListPreparer prepares the List request.

func (UsagesClient) ListResponder Uses

func (client UsagesClient) ListResponder(resp *http.Response) (result UsageList, err error)

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

func (UsagesClient) ListSender Uses

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

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

Directories

PathSynopsis
signalrapi

Package signalr imports 9 packages (graph) and is imported by 4 packages. Updated 2019-08-01. Refresh now. Tools for package owners.