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

package signalr

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

Package signalr implements the Azure ARM Signalr service API version 2020-07-01-preview.

REST API for Azure SignalR Service

Index

Package Files

client.go enums.go models.go operations.go privateendpointconnections.go privatelinkresources.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 ACLAction Uses

type ACLAction string

ACLAction enumerates the values for acl action.

const (
    // Allow ...
    Allow ACLAction = "Allow"
    // Deny ...
    Deny ACLAction = "Deny"
)

func PossibleACLActionValues Uses

func PossibleACLActionValues() []ACLAction

PossibleACLActionValues returns an array of possible values for the ACLAction const type.

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

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 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) 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 *ResourceType) (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 *ResourceType) (*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) Restart Uses

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

Restart operation to restart 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) RestartPreparer Uses

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

RestartPreparer prepares the Restart request.

func (Client) RestartResponder Uses

func (client Client) RestartResponder(resp *http.Response) (result autorest.Response, err error)

RestartResponder handles the response to the Restart request. The method always closes the http.Response Body.

func (Client) RestartSender Uses

func (client Client) RestartSender(req *http.Request) (future RestartFuture, err error)

RestartSender sends the Restart 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 *ResourceType) (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 *ResourceType) (*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 CorsSettings Uses

type CorsSettings struct {
    // AllowedOrigins - Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. If omitted, allow all by default.
    AllowedOrigins *[]string `json:"allowedOrigins,omitempty"`
}

CorsSettings cross-Origin Resource Sharing (CORS) settings.

type CreateOrUpdateFuture Uses

type CreateOrUpdateFuture struct {
    azure.FutureAPI
    // Result returns the result of the asynchronous operation.
    // If the operation has not completed it will return an error.
    Result func(Client) (ResourceType, error)
}

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

type CreateOrUpdateProperties Uses

type CreateOrUpdateProperties struct {
    // Features - List of SignalR featureFlags. e.g. ServiceMode.
    //
    // FeatureFlags that are not included in the parameters for the update operation will not be modified.
    // And the response will only include featureFlags that are explicitly set.
    // When a featureFlag is not explicitly set, SignalR service will use its globally default value.
    // But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.
    Features *[]Feature `json:"features,omitempty"`
    // Cors - Cross-Origin Resource Sharing (CORS) settings.
    Cors *CorsSettings `json:"cors,omitempty"`
    // Upstream - Upstream settings when the Azure SignalR is in server-less mode.
    Upstream *ServerlessUpstreamSettings `json:"upstream,omitempty"`
    // NetworkACLs - Network ACLs
    NetworkACLs *NetworkACLs `json:"networkACLs,omitempty"`
}

CreateOrUpdateProperties settings used to provision or configure the resource.

type DeleteFuture Uses

type DeleteFuture struct {
    azure.FutureAPI
    // Result returns the result of the asynchronous operation.
    // If the operation has not completed it will return an error.
    Result func(Client) (autorest.Response, error)
}

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

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 ErrorResponse Uses

type ErrorResponse struct {
    // Error - Describes a particular API error with an error code and a message.
    Error *ErrorResponseBody `json:"error,omitempty"`
}

ErrorResponse contains information about an API error.

type ErrorResponseBody Uses

type ErrorResponseBody struct {
    // Code - An error code that describes the error condition more precisely than an HTTP status code.
    // Can be used to programmatically handle specific error cases.
    Code *string `json:"code,omitempty"`
    // Message - A message that describes the error in detail and provides debugging information.
    Message *string `json:"message,omitempty"`
    // Target - The target of the particular error (for example, the name of the property in error).
    Target *string `json:"target,omitempty"`
    // Details - Contains nested errors that are related to this error.
    Details *[]ErrorResponseBody `json:"details,omitempty"`
}

ErrorResponseBody describes a particular API error with an error code and a message.

type Feature Uses

type Feature struct {
    // Flag - FeatureFlags is the supported features of Azure SignalR service.
    // - ServiceMode: Flag for backend server for SignalR service. Values allowed: "Default": have your own backend server; "Serverless": your application doesn't have a backend server; "Classic": for backward compatibility. Support both Default and Serverless mode but not recommended; "PredefinedOnly": for future use.
    // - EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively. Possible values include: 'ServiceMode', 'EnableConnectivityLogs', 'EnableMessagingLogs'
    Flag FeatureFlags `json:"flag,omitempty"`
    // Value - Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.
    Value *string `json:"value,omitempty"`
    // Properties - Optional properties related to this feature.
    Properties map[string]*string `json:"properties"`
}

Feature feature of a SignalR resource, which controls the SignalR runtime behavior.

func (Feature) MarshalJSON Uses

func (f Feature) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Feature.

type FeatureFlags Uses

type FeatureFlags string

FeatureFlags enumerates the values for feature flags.

const (
    // EnableConnectivityLogs ...
    EnableConnectivityLogs FeatureFlags = "EnableConnectivityLogs"
    // EnableMessagingLogs ...
    EnableMessagingLogs FeatureFlags = "EnableMessagingLogs"
    // ServiceMode ...
    ServiceMode FeatureFlags = "ServiceMode"
)

func PossibleFeatureFlagsValues Uses

func PossibleFeatureFlagsValues() []FeatureFlags

PossibleFeatureFlagsValues returns an array of possible values for the FeatureFlags const type.

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 LogSpecification Uses

type LogSpecification struct {
    // Name - Name of the log.
    Name *string `json:"name,omitempty"`
    // DisplayName - Localized friendly display name of the log.
    DisplayName *string `json:"displayName,omitempty"`
}

LogSpecification specifications of the Logs for Azure Monitoring.

type ManagedIdentity Uses

type ManagedIdentity struct {
    // Type - Represent the identity type: systemAssigned, userAssigned, None. Possible values include: 'None', 'SystemAssigned', 'UserAssigned'
    Type ManagedIdentityType `json:"type,omitempty"`
    // UserAssignedIdentities - Get or set the user assigned identities
    UserAssignedIdentities map[string]*UserAssignedIdentityProperty `json:"userAssignedIdentities"`
    // PrincipalID - READ-ONLY; Get the principal id for the system assigned identity.
    // Only be used in response.
    PrincipalID *string `json:"principalId,omitempty"`
    // TenantID - READ-ONLY; Get the tenant id for the system assigned identity.
    // Only be used in response
    TenantID *string `json:"tenantId,omitempty"`
}

ManagedIdentity a class represent managed identities used for request and response

func (ManagedIdentity) MarshalJSON Uses

func (mi ManagedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ManagedIdentity.

type ManagedIdentitySettings Uses

type ManagedIdentitySettings struct {
    // Resource - The Resource indicating the App ID URI of the target resource.
    // It also appears in the aud (audience) claim of the issued token.
    Resource *string `json:"resource,omitempty"`
}

ManagedIdentitySettings managed identity settings for upstream.

type ManagedIdentityType Uses

type ManagedIdentityType string

ManagedIdentityType enumerates the values for managed identity type.

const (
    // None ...
    None ManagedIdentityType = "None"
    // SystemAssigned ...
    SystemAssigned ManagedIdentityType = "SystemAssigned"
    // UserAssigned ...
    UserAssigned ManagedIdentityType = "UserAssigned"
)

func PossibleManagedIdentityTypeValues Uses

func PossibleManagedIdentityTypeValues() []ManagedIdentityType

PossibleManagedIdentityTypeValues returns an array of possible values for the ManagedIdentityType const type.

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 NetworkACL Uses

type NetworkACL struct {
    // Allow - Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    Allow *[]RequestType `json:"allow,omitempty"`
    // Deny - Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    Deny *[]RequestType `json:"deny,omitempty"`
}

NetworkACL network ACL

type NetworkACLs Uses

type NetworkACLs struct {
    // DefaultAction - Default action when no other rule matches. Possible values include: 'Allow', 'Deny'
    DefaultAction ACLAction `json:"defaultAction,omitempty"`
    // PublicNetwork - ACL for requests from public network
    PublicNetwork *NetworkACL `json:"publicNetwork,omitempty"`
    // PrivateEndpoints - ACLs for requests from private endpoints
    PrivateEndpoints *[]PrivateEndpointACL `json:"privateEndpoints,omitempty"`
}

NetworkACLs network ACLs for SignalR

type Operation Uses

type Operation struct {
    // Name - Name of the operation with format: {provider}/{resource}/{operation}
    Name *string `json:"name,omitempty"`
    // IsDataAction - If the operation is a data action. (for data plane rbac)
    IsDataAction *bool `json:"isDataAction,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(cur OperationList, 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 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 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 PrivateEndpoint Uses

type PrivateEndpoint struct {
    // ID - Full qualified Id of the private endpoint
    ID *string `json:"id,omitempty"`
}

PrivateEndpoint private endpoint

type PrivateEndpointACL Uses

type PrivateEndpointACL struct {
    // Name - Name of the private endpoint connection
    Name *string `json:"name,omitempty"`
    // Allow - Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    Allow *[]RequestType `json:"allow,omitempty"`
    // Deny - Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    Deny *[]RequestType `json:"deny,omitempty"`
}

PrivateEndpointACL ACL for a private endpoint

type PrivateEndpointConnection Uses

type PrivateEndpointConnection struct {
    autorest.Response `json:"-"`
    // PrivateEndpointConnectionProperties - Properties of the private endpoint connection
    *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
    // 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 resource - e.g. "Microsoft.SignalRService/SignalR"
    Type *string `json:"type,omitempty"`
}

PrivateEndpointConnection a private endpoint connection to SignalR resource

func (PrivateEndpointConnection) MarshalJSON Uses

func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON Uses

func (pec *PrivateEndpointConnection) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PrivateEndpointConnection struct.

type PrivateEndpointConnectionProperties Uses

type PrivateEndpointConnectionProperties struct {
    // ProvisioningState - READ-ONLY; Provisioning state of the private endpoint connection. Possible values include: 'Unknown', 'Succeeded', 'Failed', 'Canceled', 'Running', 'Creating', 'Updating', 'Deleting', 'Moving'
    ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
    // PrivateEndpoint - Private endpoint associated with the private endpoint connection
    PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`
    // PrivateLinkServiceConnectionState - Connection state
    PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
}

PrivateEndpointConnectionProperties private endpoint connection properties

func (PrivateEndpointConnectionProperties) MarshalJSON Uses

func (pecp PrivateEndpointConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpointConnectionProperties.

type PrivateEndpointConnectionsClient Uses

type PrivateEndpointConnectionsClient struct {
    BaseClient
}

PrivateEndpointConnectionsClient is the REST API for Azure SignalR Service

func NewPrivateEndpointConnectionsClient Uses

func NewPrivateEndpointConnectionsClient(subscriptionID string) PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates an instance of the PrivateEndpointConnectionsClient client.

func NewPrivateEndpointConnectionsClientWithBaseURI Uses

func NewPrivateEndpointConnectionsClientWithBaseURI(baseURI string, subscriptionID string) PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClientWithBaseURI creates an instance of the PrivateEndpointConnectionsClient 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 (PrivateEndpointConnectionsClient) Delete Uses

func (client PrivateEndpointConnectionsClient) Delete(ctx context.Context, privateEndpointConnectionName string, resourceGroupName string, resourceName string) (result PrivateEndpointConnectionsDeleteFuture, err error)

Delete delete the specified private endpoint connection associated with a SignalR resource. Parameters: privateEndpointConnectionName - the name of the private endpoint connection associated with the SignalR resource. 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 (PrivateEndpointConnectionsClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (PrivateEndpointConnectionsClient) DeleteResponder Uses

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

func (client PrivateEndpointConnectionsClient) DeleteSender(req *http.Request) (future PrivateEndpointConnectionsDeleteFuture, err error)

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

func (PrivateEndpointConnectionsClient) Get Uses

func (client PrivateEndpointConnectionsClient) Get(ctx context.Context, privateEndpointConnectionName string, resourceGroupName string, resourceName string) (result PrivateEndpointConnection, err error)

Get get the specified private endpoint connection associated with a SignalR resource. Parameters: privateEndpointConnectionName - the name of the private endpoint connection associated with the SignalR resource. 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 (PrivateEndpointConnectionsClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (PrivateEndpointConnectionsClient) GetResponder Uses

func (client PrivateEndpointConnectionsClient) GetResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

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

func (PrivateEndpointConnectionsClient) GetSender Uses

func (client PrivateEndpointConnectionsClient) 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 (PrivateEndpointConnectionsClient) Update Uses

func (client PrivateEndpointConnectionsClient) Update(ctx context.Context, privateEndpointConnectionName string, resourceGroupName string, resourceName string, parameters *PrivateEndpointConnection) (result PrivateEndpointConnection, err error)

Update update the state of specified private endpoint connection associated with a SignalR resource. Parameters: privateEndpointConnectionName - the name of the private endpoint connection associated with the SignalR resource. 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 - the resource of private endpoint and its properties.

func (PrivateEndpointConnectionsClient) UpdatePreparer Uses

func (client PrivateEndpointConnectionsClient) UpdatePreparer(ctx context.Context, privateEndpointConnectionName string, resourceGroupName string, resourceName string, parameters *PrivateEndpointConnection) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (PrivateEndpointConnectionsClient) UpdateResponder Uses

func (client PrivateEndpointConnectionsClient) UpdateResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

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

func (PrivateEndpointConnectionsClient) UpdateSender Uses

func (client PrivateEndpointConnectionsClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type PrivateEndpointConnectionsDeleteFuture Uses

type PrivateEndpointConnectionsDeleteFuture struct {
    azure.FutureAPI
    // Result returns the result of the asynchronous operation.
    // If the operation has not completed it will return an error.
    Result func(PrivateEndpointConnectionsClient) (autorest.Response, error)
}

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

type PrivateLinkResource Uses

type PrivateLinkResource struct {
    // PrivateLinkResourceProperties - Properties of a private link resource
    *PrivateLinkResourceProperties `json:"properties,omitempty"`
    // 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 resource - e.g. "Microsoft.SignalRService/SignalR"
    Type *string `json:"type,omitempty"`
}

PrivateLinkResource private link resource

func (PrivateLinkResource) MarshalJSON Uses

func (plr PrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON Uses

func (plr *PrivateLinkResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PrivateLinkResource struct.

type PrivateLinkResourceList Uses

type PrivateLinkResourceList struct {
    autorest.Response `json:"-"`
    // Value - List of PrivateLinkResource
    Value *[]PrivateLinkResource `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"`
}

PrivateLinkResourceList contains a list of AzSignalR.Models.Response.PrivateLink.PrivateLinkResource and a possible link to query more results

func (PrivateLinkResourceList) IsEmpty Uses

func (plrl PrivateLinkResourceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PrivateLinkResourceListIterator Uses

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

PrivateLinkResourceListIterator provides access to a complete listing of PrivateLinkResource values.

func NewPrivateLinkResourceListIterator Uses

func NewPrivateLinkResourceListIterator(page PrivateLinkResourceListPage) PrivateLinkResourceListIterator

Creates a new instance of the PrivateLinkResourceListIterator type.

func (*PrivateLinkResourceListIterator) Next Uses

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

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

func (iter PrivateLinkResourceListIterator) NotDone() bool

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

func (PrivateLinkResourceListIterator) Response Uses

func (iter PrivateLinkResourceListIterator) Response() PrivateLinkResourceList

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

func (PrivateLinkResourceListIterator) Value Uses

func (iter PrivateLinkResourceListIterator) Value() PrivateLinkResource

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

type PrivateLinkResourceListPage Uses

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

PrivateLinkResourceListPage contains a page of PrivateLinkResource values.

func NewPrivateLinkResourceListPage Uses

func NewPrivateLinkResourceListPage(cur PrivateLinkResourceList, getNextPage func(context.Context, PrivateLinkResourceList) (PrivateLinkResourceList, error)) PrivateLinkResourceListPage

Creates a new instance of the PrivateLinkResourceListPage type.

func (*PrivateLinkResourceListPage) Next Uses

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

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

func (page PrivateLinkResourceListPage) NotDone() bool

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

func (PrivateLinkResourceListPage) Response Uses

func (page PrivateLinkResourceListPage) Response() PrivateLinkResourceList

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

func (PrivateLinkResourceListPage) Values Uses

func (page PrivateLinkResourceListPage) Values() []PrivateLinkResource

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

type PrivateLinkResourceProperties Uses

type PrivateLinkResourceProperties struct {
    // GroupID - Group Id of the private link resource
    GroupID *string `json:"groupId,omitempty"`
    // RequiredMembers - Required members of the private link resource
    RequiredMembers *[]string `json:"requiredMembers,omitempty"`
    // RequiredZoneNames - Required private DNS zone names
    RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

PrivateLinkResourceProperties private link resource properties

type PrivateLinkResourcesClient Uses

type PrivateLinkResourcesClient struct {
    BaseClient
}

PrivateLinkResourcesClient is the REST API for Azure SignalR Service

func NewPrivateLinkResourcesClient Uses

func NewPrivateLinkResourcesClient(subscriptionID string) PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates an instance of the PrivateLinkResourcesClient client.

func NewPrivateLinkResourcesClientWithBaseURI Uses

func NewPrivateLinkResourcesClientWithBaseURI(baseURI string, subscriptionID string) PrivateLinkResourcesClient

NewPrivateLinkResourcesClientWithBaseURI creates an instance of the PrivateLinkResourcesClient 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 (PrivateLinkResourcesClient) List Uses

func (client PrivateLinkResourcesClient) List(ctx context.Context, resourceGroupName string, resourceName string) (result PrivateLinkResourceListPage, err error)

List get the private link resources that need to be created for a 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 (PrivateLinkResourcesClient) ListComplete Uses

func (client PrivateLinkResourcesClient) ListComplete(ctx context.Context, resourceGroupName string, resourceName string) (result PrivateLinkResourceListIterator, err error)

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

func (PrivateLinkResourcesClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (PrivateLinkResourcesClient) ListResponder Uses

func (client PrivateLinkResourcesClient) ListResponder(resp *http.Response) (result PrivateLinkResourceList, err error)

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

func (PrivateLinkResourcesClient) ListSender Uses

func (client PrivateLinkResourcesClient) 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 PrivateLinkServiceConnectionState Uses

type PrivateLinkServiceConnectionState struct {
    // Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Possible values include: 'Pending', 'Approved', 'Rejected', 'Disconnected'
    Status PrivateLinkServiceConnectionStatus `json:"status,omitempty"`
    // Description - The reason for approval/rejection of the connection.
    Description *string `json:"description,omitempty"`
    // ActionsRequired - A message indicating if changes on the service provider require any updates on the consumer.
    ActionsRequired *string `json:"actionsRequired,omitempty"`
}

PrivateLinkServiceConnectionState connection state of the private endpoint connection

type PrivateLinkServiceConnectionStatus Uses

type PrivateLinkServiceConnectionStatus string

PrivateLinkServiceConnectionStatus enumerates the values for private link service connection status.

const (
    // Approved ...
    Approved PrivateLinkServiceConnectionStatus = "Approved"
    // Disconnected ...
    Disconnected PrivateLinkServiceConnectionStatus = "Disconnected"
    // Pending ...
    Pending PrivateLinkServiceConnectionStatus = "Pending"
    // Rejected ...
    Rejected PrivateLinkServiceConnectionStatus = "Rejected"
)

func PossiblePrivateLinkServiceConnectionStatusValues Uses

func PossiblePrivateLinkServiceConnectionStatusValues() []PrivateLinkServiceConnectionStatus

PossiblePrivateLinkServiceConnectionStatusValues returns an array of possible values for the PrivateLinkServiceConnectionStatus const type.

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 accessible port of the SignalR service which is designed for browser/client side usage.
    PublicPort *int32 `json:"publicPort,omitempty"`
    // ServerPort - READ-ONLY; The publicly accessible port of the SignalR service which is designed for customer server side usage.
    ServerPort *int32 `json:"serverPort,omitempty"`
    // Version - READ-ONLY; Version of the SignalR resource. Probably you need the same or higher version of client SDKs.
    Version *string `json:"version,omitempty"`
    // PrivateEndpointConnections - READ-ONLY; Private endpoint connections to the SignalR resource.
    PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
    // TLS - TLS settings.
    TLS *TLSSettings `json:"tls,omitempty"`
    // Features - List of SignalR featureFlags. e.g. ServiceMode.
    //
    // FeatureFlags that are not included in the parameters for the update operation will not be modified.
    // And the response will only include featureFlags that are explicitly set.
    // When a featureFlag is not explicitly set, SignalR service will use its globally default value.
    // But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.
    Features *[]Feature `json:"features,omitempty"`
    // Cors - Cross-Origin Resource Sharing (CORS) settings.
    Cors *CorsSettings `json:"cors,omitempty"`
    // Upstream - Upstream settings when the Azure SignalR is in server-less mode.
    Upstream *ServerlessUpstreamSettings `json:"upstream,omitempty"`
    // NetworkACLs - Network ACLs
    NetworkACLs *NetworkACLs `json:"networkACLs,omitempty"`
}

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

func (Properties) MarshalJSON Uses

func (p Properties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Properties.

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 ProxyResource Uses

type ProxyResource 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 resource - e.g. "Microsoft.SignalRService/SignalR"
    Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a ARM proxy resource. It will have everything other than required location and tags

type RegenerateKeyFuture Uses

type RegenerateKeyFuture struct {
    azure.FutureAPI
    // Result returns the result of the asynchronous operation.
    // If the operation has not completed it will return an error.
    Result func(Client) (Keys, error)
}

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

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 RequestType Uses

type RequestType string

RequestType enumerates the values for request type.

const (
    // ClientConnection ...
    ClientConnection RequestType = "ClientConnection"
    // RESTAPI ...
    RESTAPI RequestType = "RESTAPI"
    // ServerConnection ...
    ServerConnection RequestType = "ServerConnection"
)

func PossibleRequestTypeValues Uses

func PossibleRequestTypeValues() []RequestType

PossibleRequestTypeValues returns an array of possible values for the RequestType const type.

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 resource - 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(cur ResourceList, 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. Required.
    //
    // Allowed values: Standard_S1, Free_F1
    Name *string `json:"name,omitempty"`
    // Tier - Optional tier of this particular SKU. 'Standard' or 'Free'.
    //
    // `Basic` is deprecated, use `Standard` instead. Possible values include: 'Free', 'Basic', 'Standard', 'Premium'
    Tier SkuTier `json:"tier,omitempty"`
    // Size - Optional string. For future use.
    Size *string `json:"size,omitempty"`
    // Family - Optional string. For future use.
    Family *string `json:"family,omitempty"`
    // Capacity - Optional, integer. The unit count of SignalR resource. 1 by default.
    //
    // If present, following values are allowed:
    //     Free: 1
    //     Standard: 1,2,5,10,20,50,100
    Capacity *int32 `json:"capacity,omitempty"`
}

ResourceSku the billing information of the SignalR resource.

type ResourceType Uses

type ResourceType struct {
    autorest.Response `json:"-"`
    // Sku - The billing information of the resource.(e.g. Free, Standard)
    Sku *ResourceSku `json:"sku,omitempty"`
    // Properties - Settings used to provision or configure the resource
    *Properties `json:"properties,omitempty"`
    // Kind - The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR". Possible values include: 'SignalR', 'RawWebSockets'
    Kind ServiceKind `json:"kind,omitempty"`
    // Identity - The managed identity response
    Identity *ManagedIdentity `json:"identity,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 resource - 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 RestartFuture Uses

type RestartFuture struct {
    azure.FutureAPI
    // Result returns the result of the asynchronous operation.
    // If the operation has not completed it will return an error.
    Result func(Client) (autorest.Response, error)
}

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

type ServerlessUpstreamSettings Uses

type ServerlessUpstreamSettings struct {
    // Templates - Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.
    Templates *[]UpstreamTemplate `json:"templates,omitempty"`
}

ServerlessUpstreamSettings the settings for the Upstream when the Azure SignalR is in server-less mode.

type ServiceKind Uses

type ServiceKind string

ServiceKind enumerates the values for service kind.

const (
    // RawWebSockets ...
    RawWebSockets ServiceKind = "RawWebSockets"
    // SignalR ...
    SignalR ServiceKind = "SignalR"
)

func PossibleServiceKindValues Uses

func PossibleServiceKindValues() []ServiceKind

PossibleServiceKindValues returns an array of possible values for the ServiceKind const type.

type ServiceSpecification Uses

type ServiceSpecification struct {
    // MetricSpecifications - Specifications of the Metrics for Azure Monitoring.
    MetricSpecifications *[]MetricSpecification `json:"metricSpecifications,omitempty"`
    // LogSpecifications - Specifications of the Logs for Azure Monitoring.
    LogSpecifications *[]LogSpecification `json:"logSpecifications,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 TLSSettings Uses

type TLSSettings struct {
    // ClientCertEnabled - Request client certificate during TLS handshake if enabled
    ClientCertEnabled *bool `json:"clientCertEnabled,omitempty"`
}

TLSSettings TLS settings for SignalR

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 resource - 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.FutureAPI
    // Result returns the result of the asynchronous operation.
    // If the operation has not completed it will return an error.
    Result func(Client) (ResourceType, error)
}

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

type UpstreamAuthSettings Uses

type UpstreamAuthSettings struct {
    // Type - Gets or sets the type of auth. None or ManagedIdentity is supported now. Possible values include: 'UpstreamAuthTypeNone', 'UpstreamAuthTypeManagedIdentity'
    Type UpstreamAuthType `json:"type,omitempty"`
    // ManagedIdentity - Gets or sets the managed identity settings. It's required if the auth type is set to ManagedIdentity.
    ManagedIdentity *ManagedIdentitySettings `json:"managedIdentity,omitempty"`
}

UpstreamAuthSettings upstream auth settings.

type UpstreamAuthType Uses

type UpstreamAuthType string

UpstreamAuthType enumerates the values for upstream auth type.

const (
    // UpstreamAuthTypeManagedIdentity ...
    UpstreamAuthTypeManagedIdentity UpstreamAuthType = "ManagedIdentity"
    // UpstreamAuthTypeNone ...
    UpstreamAuthTypeNone UpstreamAuthType = "None"
)

func PossibleUpstreamAuthTypeValues Uses

func PossibleUpstreamAuthTypeValues() []UpstreamAuthType

PossibleUpstreamAuthTypeValues returns an array of possible values for the UpstreamAuthType const type.

type UpstreamTemplate Uses

type UpstreamTemplate struct {
    // HubPattern - Gets or sets the matching pattern for hub names. If not set, it matches any hub.
    // There are 3 kind of patterns supported:
    //     1. "*", it to matches any hub name
    //     2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2"
    //     3. The single hub name, for example, "hub1", it matches "hub1"
    HubPattern *string `json:"hubPattern,omitempty"`
    // EventPattern - Gets or sets the matching pattern for event names. If not set, it matches any event.
    // There are 3 kind of patterns supported:
    //     1. "*", it to matches any event name
    //     2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect"
    //     3. The single event name, for example, "connect", it matches "connect"
    EventPattern *string `json:"eventPattern,omitempty"`
    // CategoryPattern - Gets or sets the matching pattern for category names. If not set, it matches any category.
    // There are 3 kind of patterns supported:
    //     1. "*", it to matches any category name
    //     2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages"
    //     3. The single category name, for example, "connections", it matches the category "connections"
    CategoryPattern *string `json:"categoryPattern,omitempty"`
    // URLTemplate - Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in.
    // For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`.
    URLTemplate *string `json:"urlTemplate,omitempty"`
    // Auth - Gets or sets the auth settings for an upstream. If not set, no auth is used for upstream messages.
    Auth *UpstreamAuthSettings `json:"auth,omitempty"`
}

UpstreamTemplate upstream template item settings. It defines the Upstream URL of the incoming requests. The template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.

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(cur UsageList, 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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

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.

type UserAssignedIdentityProperty Uses

type UserAssignedIdentityProperty struct {
    // PrincipalID - READ-ONLY; Get the principal id for the user assigned identity
    PrincipalID *string `json:"principalId,omitempty"`
    // ClientID - READ-ONLY; Get the client id for the user assigned identity
    ClientID *string `json:"clientId,omitempty"`
}

UserAssignedIdentityProperty properties of user assigned identity.

Directories

PathSynopsis
signalrapi

Package signalr imports 9 packages (graph) and is imported by 1 packages. Updated 2021-01-17. Refresh now. Tools for package owners.