webpubsub

package
v58.0.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Sep 30, 2021 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package webpubsub implements the Azure ARM Webpubsub service API version 2021-06-01-preview.

REST API for Azure WebPubSub Service

Index

Constants

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

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

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

func Version 

func Version() string

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

Types

type ACLAction 

type ACLAction string

ACLAction enumerates the values for acl action. 

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

func PossibleACLActionValues 

func PossibleACLActionValues() []ACLAction

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

type BaseClient 

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

BaseClient is the base client for Webpubsub.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type Client 

type Client struct {
	BaseClient
}

Client is the REST API for Azure WebPubSub Service

func NewClient 

func NewClient(subscriptionID string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI 

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 

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

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

func (Client) CheckNameAvailabilityPreparer 

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

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (Client) CheckNameAvailabilityResponder 

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 

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 

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

CreateOrUpdate create or update a resource. Parameters: parameters - parameters for the create or update operation 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 resource.

func (Client) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (Client) CreateOrUpdateResponder 

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

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

func (Client) CreateOrUpdateSender 

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 

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

Delete operation to delete a 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 resource.

func (Client) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (Client) DeleteResponder 

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 

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 

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

Get get the resource 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 resource.

func (Client) GetPreparer 

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

GetPreparer prepares the Get request.

func (Client) GetResponder 

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

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

func (Client) GetSender 

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 

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 

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 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (Client) ListByResourceGroupResponder 

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 

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 

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

ListBySubscription handles requests to list all resources in a subscription.

func (Client) ListBySubscriptionComplete 

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

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

func (Client) ListBySubscriptionPreparer 

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

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (Client) ListBySubscriptionResponder 

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 

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 

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

ListKeys get the access keys of the 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 resource.

func (Client) ListKeysPreparer 

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

ListKeysPreparer prepares the ListKeys request.

func (Client) ListKeysResponder 

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 

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 

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

RegenerateKey regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time. Parameters: parameters - parameter that describes the Regenerate Key Operation. 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 resource.

func (Client) RegenerateKeyPreparer 

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

RegenerateKeyPreparer prepares the RegenerateKey request.

func (Client) RegenerateKeyResponder 

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 

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 

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

Restart operation to restart a 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 resource.

func (Client) RestartPreparer 

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

RestartPreparer prepares the Restart request.

func (Client) RestartResponder 

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 

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 

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

Update operation to update an exiting resource. Parameters: parameters - parameters for the update operation 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 resource.

func (Client) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (Client) UpdateResponder 

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 

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 

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.

func (*CreateOrUpdateFuture) UnmarshalJSON 

func (future *CreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CreatedByType 

type CreatedByType string

CreatedByType enumerates the values for created by type. 

const (
	// CreatedByTypeApplication ...
	CreatedByTypeApplication CreatedByType = "Application"
	// CreatedByTypeKey ...
	CreatedByTypeKey CreatedByType = "Key"
	// CreatedByTypeManagedIdentity ...
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	// CreatedByTypeUser ...
	CreatedByTypeUser CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.

type DeleteFuture 

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.

func (*DeleteFuture) UnmarshalJSON 

func (future *DeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DiagnosticConfiguration 

type DiagnosticConfiguration struct {
	// EnableConnectivityLogs - Indicate whether or not enable Connectivity logs.
	// Available values: Enabled, Disabled.
	// Case insensitive.
	EnableConnectivityLogs *string `json:"enableConnectivityLogs,omitempty"`
	// EnableMessagingLogs - Indicate whether or not enable Messaging logs.
	// Available values: Enabled, Disabled.
	// Case insensitive.
	EnableMessagingLogs *string `json:"enableMessagingLogs,omitempty"`
	// EnableLiveTrace - Indicate whether or not enable Live Trace.
	// Available values: Enabled, Disabled.
	// Case insensitive.
	// Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues.
	EnableLiveTrace *string `json:"enableLiveTrace,omitempty"`
}

DiagnosticConfiguration diagnostic configuration of a Microsoft.SignalRService resource. Used together with Azure monitor DiagnosticSettings.

type Dimension 

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 ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// Type - READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty"`
	// Info - READ-ONLY; The additional info.
	Info interface{} `json:"info,omitempty"`
}

ErrorAdditionalInfo the resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON 

func (eai ErrorAdditionalInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorAdditionalInfo.

type ErrorDetail 

type ErrorDetail struct {
	// Code - READ-ONLY; The error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; The error message.
	Message *string `json:"message,omitempty"`
	// Target - READ-ONLY; The error target.
	Target *string `json:"target,omitempty"`
	// Details - READ-ONLY; The error details.
	Details *[]ErrorDetail `json:"details,omitempty"`
	// AdditionalInfo - READ-ONLY; The error additional info.
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}

ErrorDetail the error detail.

func (ErrorDetail) MarshalJSON 

func (ed ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// Error - The error object.
	Error *ErrorDetail `json:"error,omitempty"`
}

ErrorResponse common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

type EventHandlerSettings 

type EventHandlerSettings struct {
	// Items - Get or set the EventHandler items. The key is the hub name and the value is the corresponding EventHandlerTemplate.
	Items map[string][]EventHandlerTemplate `json:"items"`
}

EventHandlerSettings the settings for event handler in webpubsub service

func (EventHandlerSettings) MarshalJSON 

func (ehs EventHandlerSettings) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EventHandlerSettings.

type EventHandlerTemplate 

type EventHandlerTemplate struct {
	// URLTemplate - Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in.
	// For example, UrlTemplate can be `http://example.com/api/{hub}/{event}`. The host part can't contains parameters.
	URLTemplate *string `json:"urlTemplate,omitempty"`
	// UserEventPattern - Gets or sets the matching pattern for event names.
	// There are 3 kind of patterns supported:
	//     1. "*", it to matches any event name
	//     2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2"
	//     3. The single event name, for example, "event1", it matches "event1"
	UserEventPattern *string `json:"userEventPattern,omitempty"`
	// SystemEventPattern - Gets ot sets the system event pattern.
	// There are 2 kind of patterns supported:
	//     1. The single event name, for example, "connect", it matches "connect"
	//     2. Combine multiple events with ",", for example "connect,disconnected", it matches event "connect" and "disconnected"
	SystemEventPattern *string `json:"systemEventPattern,omitempty"`
	// Auth - Gets or sets the auth settings for an event handler. If not set, no auth is used.
	Auth *UpstreamAuthSettings `json:"auth,omitempty"`
}

EventHandlerTemplate eventHandler template item settings.

type KeyType 

type KeyType string

KeyType enumerates the values for key type. 

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

func PossibleKeyTypeValues 

func PossibleKeyTypeValues() []KeyType

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

type Keys 

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 - Connection string constructed via the primaryKey
	PrimaryConnectionString *string `json:"primaryConnectionString,omitempty"`
	// SecondaryConnectionString - Connection string constructed via the secondaryKey
	SecondaryConnectionString *string `json:"secondaryConnectionString,omitempty"`
}

Keys a class represents the access keys of the resource.

type LogSpecification 

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 

type ManagedIdentity struct {
	// Type - Represent the identity type: systemAssigned, userAssigned, None. Possible values include: 'ManagedIdentityTypeNone', 'ManagedIdentityTypeSystemAssigned', 'ManagedIdentityTypeUserAssigned'
	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 

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

MarshalJSON is the custom marshaler for ManagedIdentity.

type ManagedIdentitySettings 

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 

type ManagedIdentityType string

ManagedIdentityType enumerates the values for managed identity type. 

const (
	// ManagedIdentityTypeNone ...
	ManagedIdentityTypeNone ManagedIdentityType = "None"
	// ManagedIdentityTypeSystemAssigned ...
	ManagedIdentityTypeSystemAssigned ManagedIdentityType = "SystemAssigned"
	// ManagedIdentityTypeUserAssigned ...
	ManagedIdentityTypeUserAssigned ManagedIdentityType = "UserAssigned"
)

func PossibleManagedIdentityTypeValues 

func PossibleManagedIdentityTypeValues() []ManagedIdentityType

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

type MetricSpecification 

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 

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 

type NameAvailabilityParameters struct {
	// Type - The resource type. Can be "Microsoft.SignalRService/SignalR" or "Microsoft.SignalRService/webPubSub"
	Type *string `json:"type,omitempty"`
	// Name - The resource name to validate. e.g."my-resource-name"
	Name *string `json:"name,omitempty"`
}

NameAvailabilityParameters data POST-ed to the nameAvailability action

type NetworkACL 

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 

type NetworkACLs struct {
	// DefaultAction - Default action when no other rule matches. Possible values include: 'ACLActionAllow', 'ACLActionDeny'
	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 the resource

type Operation 

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 resource provider.

type OperationDisplay 

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 

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 

func (ol OperationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListIterator 

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

OperationListIterator provides access to a complete listing of Operation values.

func NewOperationListIterator 

func NewOperationListIterator(page OperationListPage) OperationListIterator

Creates a new instance of the OperationListIterator type.

func (*OperationListIterator) Next 

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 

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 

func (iter OperationListIterator) NotDone() bool

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

func (OperationListIterator) Response 

func (iter OperationListIterator) Response() OperationList

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

func (OperationListIterator) Value 

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 

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

OperationListPage contains a page of Operation values.

func NewOperationListPage 

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

Creates a new instance of the OperationListPage type.

func (*OperationListPage) Next 

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 

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 

func (page OperationListPage) NotDone() bool

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

func (OperationListPage) Response 

func (page OperationListPage) Response() OperationList

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

func (OperationListPage) Values 

func (page OperationListPage) Values() []Operation

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

type OperationProperties 

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

OperationProperties extra Operation properties.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the REST API for Azure WebPubSub Service

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List 

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

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

func (OperationsClient) ListComplete 

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

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

func (OperationsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

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 

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 

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

PrivateEndpoint private endpoint

type PrivateEndpointACL 

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 

type PrivateEndpointConnection struct {
	autorest.Response `json:"-"`
	// SystemData - READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty"`
	// 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 an azure resource

func (PrivateEndpointConnection) MarshalJSON 

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

MarshalJSON is the custom marshaler for PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for PrivateEndpointConnection struct.

type PrivateEndpointConnectionList 

type PrivateEndpointConnectionList struct {
	autorest.Response `json:"-"`
	// Value - The list of the private endpoint connections
	Value *[]PrivateEndpointConnection `json:"value,omitempty"`
	// NextLink - Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.
	NextLink *string `json:"nextLink,omitempty"`
}

PrivateEndpointConnectionList a list of private endpoint connections

func (PrivateEndpointConnectionList) IsEmpty 

func (pecl PrivateEndpointConnectionList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PrivateEndpointConnectionListIterator 

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

PrivateEndpointConnectionListIterator provides access to a complete listing of PrivateEndpointConnection values.

func NewPrivateEndpointConnectionListIterator 

func NewPrivateEndpointConnectionListIterator(page PrivateEndpointConnectionListPage) PrivateEndpointConnectionListIterator

Creates a new instance of the PrivateEndpointConnectionListIterator type.

func (*PrivateEndpointConnectionListIterator) Next 

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

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

func (iter PrivateEndpointConnectionListIterator) NotDone() bool

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

func (PrivateEndpointConnectionListIterator) Response 

func (iter PrivateEndpointConnectionListIterator) Response() PrivateEndpointConnectionList

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

func (PrivateEndpointConnectionListIterator) Value 

func (iter PrivateEndpointConnectionListIterator) Value() PrivateEndpointConnection

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

type PrivateEndpointConnectionListPage 

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

PrivateEndpointConnectionListPage contains a page of PrivateEndpointConnection values.

func NewPrivateEndpointConnectionListPage 

func NewPrivateEndpointConnectionListPage(cur PrivateEndpointConnectionList, getNextPage func(context.Context, PrivateEndpointConnectionList) (PrivateEndpointConnectionList, error)) PrivateEndpointConnectionListPage

Creates a new instance of the PrivateEndpointConnectionListPage type.

func (*PrivateEndpointConnectionListPage) Next 

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

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

func (page PrivateEndpointConnectionListPage) NotDone() bool

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

func (PrivateEndpointConnectionListPage) Response 

func (page PrivateEndpointConnectionListPage) Response() PrivateEndpointConnectionList

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

func (PrivateEndpointConnectionListPage) Values 

func (page PrivateEndpointConnectionListPage) Values() []PrivateEndpointConnection

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

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// ProvisioningState - READ-ONLY; Provisioning state of the private endpoint connection. Possible values include: 'ProvisioningStateUnknown', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateCanceled', 'ProvisioningStateRunning', 'ProvisioningStateCreating', 'ProvisioningStateUpdating', 'ProvisioningStateDeleting', 'ProvisioningStateMoving'
	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 

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

MarshalJSON is the custom marshaler for PrivateEndpointConnectionProperties.

type PrivateEndpointConnectionsClient 

type PrivateEndpointConnectionsClient struct {
	BaseClient
}

PrivateEndpointConnectionsClient is the REST API for Azure WebPubSub Service

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string) PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates an instance of the PrivateEndpointConnectionsClient client.

func NewPrivateEndpointConnectionsClientWithBaseURI 

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 

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

Delete delete the specified private endpoint connection Parameters: privateEndpointConnectionName - the name of the private endpoint connection 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 resource.

func (PrivateEndpointConnectionsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (PrivateEndpointConnectionsClient) DeleteResponder 

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 

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 

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

Get get the specified private endpoint connection Parameters: privateEndpointConnectionName - the name of the private endpoint connection 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 resource.

func (PrivateEndpointConnectionsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (PrivateEndpointConnectionsClient) GetResponder 

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 

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

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

List list private endpoint connections 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 resource.

func (PrivateEndpointConnectionsClient) ListComplete 

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

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

func (PrivateEndpointConnectionsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (PrivateEndpointConnectionsClient) ListResponder 

func (client PrivateEndpointConnectionsClient) ListResponder(resp *http.Response) (result PrivateEndpointConnectionList, err error)

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

func (PrivateEndpointConnectionsClient) ListSender 

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

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

func (PrivateEndpointConnectionsClient) Update 

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

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

func (PrivateEndpointConnectionsClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (PrivateEndpointConnectionsClient) UpdateResponder 

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 

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 

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.

func (*PrivateEndpointConnectionsDeleteFuture) UnmarshalJSON 

func (future *PrivateEndpointConnectionsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type PrivateLinkResource 

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 

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

MarshalJSON is the custom marshaler for PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for PrivateLinkResource struct.

type PrivateLinkResourceList 

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 PrivateLinkResource and a possible link to query more results

func (PrivateLinkResourceList) IsEmpty 

func (plrl PrivateLinkResourceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PrivateLinkResourceListIterator 

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

PrivateLinkResourceListIterator provides access to a complete listing of PrivateLinkResource values.

func NewPrivateLinkResourceListIterator 

func NewPrivateLinkResourceListIterator(page PrivateLinkResourceListPage) PrivateLinkResourceListIterator

Creates a new instance of the PrivateLinkResourceListIterator type.

func (*PrivateLinkResourceListIterator) Next 

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 

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 

func (iter PrivateLinkResourceListIterator) NotDone() bool

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

func (PrivateLinkResourceListIterator) Response 

func (iter PrivateLinkResourceListIterator) Response() PrivateLinkResourceList

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

func (PrivateLinkResourceListIterator) Value 

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 

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

PrivateLinkResourceListPage contains a page of PrivateLinkResource values.

func NewPrivateLinkResourceListPage 

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

Creates a new instance of the PrivateLinkResourceListPage type.

func (*PrivateLinkResourceListPage) Next 

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 

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 

func (page PrivateLinkResourceListPage) NotDone() bool

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

func (PrivateLinkResourceListPage) Response 

func (page PrivateLinkResourceListPage) Response() PrivateLinkResourceList

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

func (PrivateLinkResourceListPage) Values 

func (page PrivateLinkResourceListPage) Values() []PrivateLinkResource

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

type PrivateLinkResourceProperties 

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"`
	// ShareablePrivateLinkResourceTypes - The list of resources that are onboarded to private link service
	ShareablePrivateLinkResourceTypes *[]ShareablePrivateLinkResourceType `json:"shareablePrivateLinkResourceTypes,omitempty"`
}

PrivateLinkResourceProperties private link resource properties

type PrivateLinkResourcesClient 

type PrivateLinkResourcesClient struct {
	BaseClient
}

PrivateLinkResourcesClient is the REST API for Azure WebPubSub Service

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string) PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates an instance of the PrivateLinkResourcesClient client.

func NewPrivateLinkResourcesClientWithBaseURI 

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 

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 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 resource.

func (PrivateLinkResourcesClient) ListComplete 

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 

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

ListPreparer prepares the List request.

func (PrivateLinkResourcesClient) ListResponder 

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 

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 

type PrivateLinkServiceConnectionState struct {
	// Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Possible values include: 'PrivateLinkServiceConnectionStatusPending', 'PrivateLinkServiceConnectionStatusApproved', 'PrivateLinkServiceConnectionStatusRejected', 'PrivateLinkServiceConnectionStatusDisconnected'
	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 

type PrivateLinkServiceConnectionStatus string

PrivateLinkServiceConnectionStatus enumerates the values for private link service connection status. 

const (
	// PrivateLinkServiceConnectionStatusApproved ...
	PrivateLinkServiceConnectionStatusApproved PrivateLinkServiceConnectionStatus = "Approved"
	// PrivateLinkServiceConnectionStatusDisconnected ...
	PrivateLinkServiceConnectionStatusDisconnected PrivateLinkServiceConnectionStatus = "Disconnected"
	// PrivateLinkServiceConnectionStatusPending ...
	PrivateLinkServiceConnectionStatusPending PrivateLinkServiceConnectionStatus = "Pending"
	// PrivateLinkServiceConnectionStatusRejected ...
	PrivateLinkServiceConnectionStatusRejected PrivateLinkServiceConnectionStatus = "Rejected"
)

func PossiblePrivateLinkServiceConnectionStatusValues 

func PossiblePrivateLinkServiceConnectionStatusValues() []PrivateLinkServiceConnectionStatus

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

type Properties 

type Properties struct {
	// ProvisioningState - READ-ONLY; Provisioning state of the resource. Possible values include: 'ProvisioningStateUnknown', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateCanceled', 'ProvisioningStateRunning', 'ProvisioningStateCreating', 'ProvisioningStateUpdating', 'ProvisioningStateDeleting', 'ProvisioningStateMoving'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// ExternalIP - READ-ONLY; The publicly accessible IP of the resource.
	ExternalIP *string `json:"externalIP,omitempty"`
	// HostName - READ-ONLY; FQDN of the service instance.
	HostName *string `json:"hostName,omitempty"`
	// PublicPort - READ-ONLY; The publicly accessible port of the resource which is designed for browser/client side usage.
	PublicPort *int32 `json:"publicPort,omitempty"`
	// ServerPort - READ-ONLY; The publicly accessible port of the resource which is designed for customer server side usage.
	ServerPort *int32 `json:"serverPort,omitempty"`
	// Version - READ-ONLY; Version of the 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 resource.
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	// SharedPrivateLinkResources - READ-ONLY; The list of shared private link resources.
	SharedPrivateLinkResources *[]SharedPrivateLinkResource `json:"sharedPrivateLinkResources,omitempty"`
	// TLS - TLS settings.
	TLS *TLSSettings `json:"tls,omitempty"`
	// DiagnosticConfiguration - Diagnostic configuration of a Microsoft.SignalRService resource. Used together with Azure monitor DiagnosticSettings.
	DiagnosticConfiguration *DiagnosticConfiguration `json:"diagnosticConfiguration,omitempty"`
	// EventHandler - The settings for event handler in webpubsub service.
	EventHandler *EventHandlerSettings `json:"eventHandler,omitempty"`
	// NetworkACLs - Network ACLs
	NetworkACLs *NetworkACLs `json:"networkACLs,omitempty"`
	// PublicNetworkAccess - Enable or disable public network access. Default to "Enabled".
	// When it's Enabled, network ACLs still apply.
	// When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
	PublicNetworkAccess *string `json:"publicNetworkAccess,omitempty"`
	// DisableLocalAuth - DisableLocalAuth
	// Enable or disable local auth with AccessKey
	// When set as true, connection with AccessKey=xxx won't work.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`
	// DisableAadAuth - DisableLocalAuth
	// Enable or disable aad auth
	// When set as true, connection with AuthType=aad won't work.
	DisableAadAuth *bool `json:"disableAadAuth,omitempty"`
}

Properties a class that describes the properties of the resource

func (Properties) MarshalJSON 

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

MarshalJSON is the custom marshaler for Properties.

type ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// ProvisioningStateCanceled ...
	ProvisioningStateCanceled ProvisioningState = "Canceled"
	// ProvisioningStateCreating ...
	ProvisioningStateCreating ProvisioningState = "Creating"
	// ProvisioningStateDeleting ...
	ProvisioningStateDeleting ProvisioningState = "Deleting"
	// ProvisioningStateFailed ...
	ProvisioningStateFailed ProvisioningState = "Failed"
	// ProvisioningStateMoving ...
	ProvisioningStateMoving ProvisioningState = "Moving"
	// ProvisioningStateRunning ...
	ProvisioningStateRunning ProvisioningState = "Running"
	// ProvisioningStateSucceeded ...
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	// ProvisioningStateUnknown ...
	ProvisioningStateUnknown ProvisioningState = "Unknown"
	// ProvisioningStateUpdating ...
	ProvisioningStateUpdating ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

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

type ProxyResource 

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

func (ProxyResource) MarshalJSON 

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type RegenerateKeyFuture 

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.

func (*RegenerateKeyFuture) UnmarshalJSON 

func (future *RegenerateKeyFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type RegenerateKeyParameters 

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

RegenerateKeyParameters parameters describes the request to regenerate access keys

type RequestType 

type RequestType string

RequestType enumerates the values for request type. 

const (
	// RequestTypeClientConnection ...
	RequestTypeClientConnection RequestType = "ClientConnection"
	// RequestTypeRESTAPI ...
	RequestTypeRESTAPI RequestType = "RESTAPI"
	// RequestTypeServerConnection ...
	RequestTypeServerConnection RequestType = "ServerConnection"
	// RequestTypeTrace ...
	RequestTypeTrace RequestType = "Trace"
)

func PossibleRequestTypeValues 

func PossibleRequestTypeValues() []RequestType

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

type Resource 

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.

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type ResourceList 

type ResourceList struct {
	autorest.Response `json:"-"`
	// Value - List of the resources
	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 resources and a possible link for next set.

func (ResourceList) IsEmpty 

func (rl ResourceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ResourceListIterator 

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

ResourceListIterator provides access to a complete listing of ResourceType values.

func NewResourceListIterator 

func NewResourceListIterator(page ResourceListPage) ResourceListIterator

Creates a new instance of the ResourceListIterator type.

func (*ResourceListIterator) Next 

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 

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 

func (iter ResourceListIterator) NotDone() bool

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

func (ResourceListIterator) Response 

func (iter ResourceListIterator) Response() ResourceList

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

func (ResourceListIterator) Value 

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 

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

ResourceListPage contains a page of ResourceType values.

func NewResourceListPage 

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

Creates a new instance of the ResourceListPage type.

func (*ResourceListPage) Next 

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 

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 

func (page ResourceListPage) NotDone() bool

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

func (ResourceListPage) Response 

func (page ResourceListPage) Response() ResourceList

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

func (ResourceListPage) Values 

func (page ResourceListPage) Values() []ResourceType

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

type ResourceSku 

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: 'SkuTierFree', 'SkuTierBasic', 'SkuTierStandard', 'SkuTierPremium'
	Tier SkuTier `json:"tier,omitempty"`
	// Size - READ-ONLY; Not used. Retained for future use.
	Size *string `json:"size,omitempty"`
	// Family - READ-ONLY; Not used. Retained for future use.
	Family *string `json:"family,omitempty"`
	// Capacity - Optional, integer. The unit count of the 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 resource.

func (ResourceSku) MarshalJSON 

func (rs ResourceSku) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceSku.

type ResourceType 

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"`
	// Identity - The managed identity response
	Identity *ManagedIdentity `json:"identity,omitempty"`
	// SystemData - READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty"`
	// Location - The GEO location of the resource. 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 resource.

func (ResourceType) MarshalJSON 

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

MarshalJSON is the custom marshaler for ResourceType.

func (*ResourceType) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for ResourceType struct.

type RestartFuture 

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.

func (*RestartFuture) UnmarshalJSON 

func (future *RestartFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ServiceSpecification 

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 ShareablePrivateLinkResourceProperties 

type ShareablePrivateLinkResourceProperties struct {
	// Description - The description of the resource type that has been onboarded to private link service
	Description *string `json:"description,omitempty"`
	// GroupID - The resource provider group id for the resource that has been onboarded to private link service
	GroupID *string `json:"groupId,omitempty"`
	// Type - The resource provider type for the resource that has been onboarded to private link service
	Type *string `json:"type,omitempty"`
}

ShareablePrivateLinkResourceProperties describes the properties of a resource type that has been onboarded to private link service

type ShareablePrivateLinkResourceType 

type ShareablePrivateLinkResourceType struct {
	// Name - The name of the resource type that has been onboarded to private link service
	Name *string `json:"name,omitempty"`
	// Properties - Describes the properties of a resource type that has been onboarded to private link service
	Properties *ShareablePrivateLinkResourceProperties `json:"properties,omitempty"`
}

ShareablePrivateLinkResourceType describes a resource type that has been onboarded to private link service

type SharedPrivateLinkResource 

type SharedPrivateLinkResource struct {
	autorest.Response `json:"-"`
	// SystemData - READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty"`
	// SharedPrivateLinkResourceProperties - Describes the properties of a Shared Private Link Resource
	*SharedPrivateLinkResourceProperties `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"`
}

SharedPrivateLinkResource describes a Shared Private Link Resource

func (SharedPrivateLinkResource) MarshalJSON 

func (splr SharedPrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SharedPrivateLinkResource.

func (*SharedPrivateLinkResource) UnmarshalJSON 

func (splr *SharedPrivateLinkResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SharedPrivateLinkResource struct.

type SharedPrivateLinkResourceList 

type SharedPrivateLinkResourceList struct {
	autorest.Response `json:"-"`
	// Value - The list of the shared private link resources
	Value *[]SharedPrivateLinkResource `json:"value,omitempty"`
	// NextLink - Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.
	NextLink *string `json:"nextLink,omitempty"`
}

SharedPrivateLinkResourceList a list of shared private link resources

func (SharedPrivateLinkResourceList) IsEmpty 

func (splrl SharedPrivateLinkResourceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type SharedPrivateLinkResourceListIterator 

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

SharedPrivateLinkResourceListIterator provides access to a complete listing of SharedPrivateLinkResource values.

func NewSharedPrivateLinkResourceListIterator 

func NewSharedPrivateLinkResourceListIterator(page SharedPrivateLinkResourceListPage) SharedPrivateLinkResourceListIterator

Creates a new instance of the SharedPrivateLinkResourceListIterator type.

func (*SharedPrivateLinkResourceListIterator) Next 

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

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

func (iter SharedPrivateLinkResourceListIterator) NotDone() bool

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

func (SharedPrivateLinkResourceListIterator) Response 

func (iter SharedPrivateLinkResourceListIterator) Response() SharedPrivateLinkResourceList

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

func (SharedPrivateLinkResourceListIterator) Value 

func (iter SharedPrivateLinkResourceListIterator) Value() SharedPrivateLinkResource

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

type SharedPrivateLinkResourceListPage 

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

SharedPrivateLinkResourceListPage contains a page of SharedPrivateLinkResource values.

func NewSharedPrivateLinkResourceListPage 

func NewSharedPrivateLinkResourceListPage(cur SharedPrivateLinkResourceList, getNextPage func(context.Context, SharedPrivateLinkResourceList) (SharedPrivateLinkResourceList, error)) SharedPrivateLinkResourceListPage

Creates a new instance of the SharedPrivateLinkResourceListPage type.

func (*SharedPrivateLinkResourceListPage) Next 

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

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

func (page SharedPrivateLinkResourceListPage) NotDone() bool

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

func (SharedPrivateLinkResourceListPage) Response 

func (page SharedPrivateLinkResourceListPage) Response() SharedPrivateLinkResourceList

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

func (SharedPrivateLinkResourceListPage) Values 

func (page SharedPrivateLinkResourceListPage) Values() []SharedPrivateLinkResource

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

type SharedPrivateLinkResourceProperties 

type SharedPrivateLinkResourceProperties struct {
	// GroupID - The group id from the provider of resource the shared private link resource is for
	GroupID *string `json:"groupId,omitempty"`
	// PrivateLinkResourceID - The resource id of the resource the shared private link resource is for
	PrivateLinkResourceID *string `json:"privateLinkResourceId,omitempty"`
	// ProvisioningState - READ-ONLY; Provisioning state of the shared private link resource. Possible values include: 'ProvisioningStateUnknown', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateCanceled', 'ProvisioningStateRunning', 'ProvisioningStateCreating', 'ProvisioningStateUpdating', 'ProvisioningStateDeleting', 'ProvisioningStateMoving'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// RequestMessage - The request message for requesting approval of the shared private link resource
	RequestMessage *string `json:"requestMessage,omitempty"`
	// Status - READ-ONLY; Status of the shared private link resource. Possible values include: 'SharedPrivateLinkResourceStatusPending', 'SharedPrivateLinkResourceStatusApproved', 'SharedPrivateLinkResourceStatusRejected', 'SharedPrivateLinkResourceStatusDisconnected', 'SharedPrivateLinkResourceStatusTimeout'
	Status SharedPrivateLinkResourceStatus `json:"status,omitempty"`
}

SharedPrivateLinkResourceProperties describes the properties of an existing Shared Private Link Resource

func (SharedPrivateLinkResourceProperties) MarshalJSON 

func (splrp SharedPrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SharedPrivateLinkResourceProperties.

type SharedPrivateLinkResourceStatus 

type SharedPrivateLinkResourceStatus string

SharedPrivateLinkResourceStatus enumerates the values for shared private link resource status. 

const (
	// SharedPrivateLinkResourceStatusApproved ...
	SharedPrivateLinkResourceStatusApproved SharedPrivateLinkResourceStatus = "Approved"
	// SharedPrivateLinkResourceStatusDisconnected ...
	SharedPrivateLinkResourceStatusDisconnected SharedPrivateLinkResourceStatus = "Disconnected"
	// SharedPrivateLinkResourceStatusPending ...
	SharedPrivateLinkResourceStatusPending SharedPrivateLinkResourceStatus = "Pending"
	// SharedPrivateLinkResourceStatusRejected ...
	SharedPrivateLinkResourceStatusRejected SharedPrivateLinkResourceStatus = "Rejected"
	// SharedPrivateLinkResourceStatusTimeout ...
	SharedPrivateLinkResourceStatusTimeout SharedPrivateLinkResourceStatus = "Timeout"
)

func PossibleSharedPrivateLinkResourceStatusValues 

func PossibleSharedPrivateLinkResourceStatusValues() []SharedPrivateLinkResourceStatus

PossibleSharedPrivateLinkResourceStatusValues returns an array of possible values for the SharedPrivateLinkResourceStatus const type.

type SharedPrivateLinkResourcesClient 

type SharedPrivateLinkResourcesClient struct {
	BaseClient
}

SharedPrivateLinkResourcesClient is the REST API for Azure WebPubSub Service

func NewSharedPrivateLinkResourcesClient 

func NewSharedPrivateLinkResourcesClient(subscriptionID string) SharedPrivateLinkResourcesClient

NewSharedPrivateLinkResourcesClient creates an instance of the SharedPrivateLinkResourcesClient client.

func NewSharedPrivateLinkResourcesClientWithBaseURI 

func NewSharedPrivateLinkResourcesClientWithBaseURI(baseURI string, subscriptionID string) SharedPrivateLinkResourcesClient

NewSharedPrivateLinkResourcesClientWithBaseURI creates an instance of the SharedPrivateLinkResourcesClient 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 (SharedPrivateLinkResourcesClient) CreateOrUpdate 

func (client SharedPrivateLinkResourcesClient) CreateOrUpdate(ctx context.Context, sharedPrivateLinkResourceName string, parameters SharedPrivateLinkResource, resourceGroupName string, resourceName string) (result SharedPrivateLinkResourcesCreateOrUpdateFuture, err error)

CreateOrUpdate create or update a shared private link resource Parameters: sharedPrivateLinkResourceName - the name of the shared private link resource parameters - the shared private link 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 resource.

func (SharedPrivateLinkResourcesClient) CreateOrUpdatePreparer 

func (client SharedPrivateLinkResourcesClient) CreateOrUpdatePreparer(ctx context.Context, sharedPrivateLinkResourceName string, parameters SharedPrivateLinkResource, resourceGroupName string, resourceName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (SharedPrivateLinkResourcesClient) CreateOrUpdateResponder 

func (client SharedPrivateLinkResourcesClient) CreateOrUpdateResponder(resp *http.Response) (result SharedPrivateLinkResource, err error)

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

func (SharedPrivateLinkResourcesClient) CreateOrUpdateSender 

func (client SharedPrivateLinkResourcesClient) CreateOrUpdateSender(req *http.Request) (future SharedPrivateLinkResourcesCreateOrUpdateFuture, err error)

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

func (SharedPrivateLinkResourcesClient) Delete 

func (client SharedPrivateLinkResourcesClient) Delete(ctx context.Context, sharedPrivateLinkResourceName string, resourceGroupName string, resourceName string) (result SharedPrivateLinkResourcesDeleteFuture, err error)

Delete delete the specified shared private link resource Parameters: sharedPrivateLinkResourceName - the name of the shared private link 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 resource.

func (SharedPrivateLinkResourcesClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (SharedPrivateLinkResourcesClient) DeleteResponder 

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

func (client SharedPrivateLinkResourcesClient) DeleteSender(req *http.Request) (future SharedPrivateLinkResourcesDeleteFuture, err error)

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

func (SharedPrivateLinkResourcesClient) Get 

func (client SharedPrivateLinkResourcesClient) Get(ctx context.Context, sharedPrivateLinkResourceName string, resourceGroupName string, resourceName string) (result SharedPrivateLinkResource, err error)

Get get the specified shared private link resource Parameters: sharedPrivateLinkResourceName - the name of the shared private link 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 resource.

func (SharedPrivateLinkResourcesClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (SharedPrivateLinkResourcesClient) GetResponder 

func (client SharedPrivateLinkResourcesClient) GetResponder(resp *http.Response) (result SharedPrivateLinkResource, err error)

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

func (SharedPrivateLinkResourcesClient) GetSender 

func (client SharedPrivateLinkResourcesClient) 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 (SharedPrivateLinkResourcesClient) List 

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

List list shared private link resources 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 resource.

func (SharedPrivateLinkResourcesClient) ListComplete 

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

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

func (SharedPrivateLinkResourcesClient) ListPreparer 

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

ListPreparer prepares the List request.

func (SharedPrivateLinkResourcesClient) ListResponder 

func (client SharedPrivateLinkResourcesClient) ListResponder(resp *http.Response) (result SharedPrivateLinkResourceList, err error)

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

func (SharedPrivateLinkResourcesClient) ListSender 

func (client SharedPrivateLinkResourcesClient) 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 SharedPrivateLinkResourcesCreateOrUpdateFuture 

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

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

func (*SharedPrivateLinkResourcesCreateOrUpdateFuture) UnmarshalJSON 

func (future *SharedPrivateLinkResourcesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type SharedPrivateLinkResourcesDeleteFuture 

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

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

func (*SharedPrivateLinkResourcesDeleteFuture) UnmarshalJSON 

func (future *SharedPrivateLinkResourcesDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type SignalRServiceUsage 

type SignalRServiceUsage 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 *SignalRServiceUsageName `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"`
}

SignalRServiceUsage object that describes a specific usage of the resources.

type SignalRServiceUsageList 

type SignalRServiceUsageList struct {
	autorest.Response `json:"-"`
	// Value - List of the resource usages
	Value *[]SignalRServiceUsage `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"`
}

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

func (SignalRServiceUsageList) IsEmpty 

func (srsul SignalRServiceUsageList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type SignalRServiceUsageListIterator 

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

SignalRServiceUsageListIterator provides access to a complete listing of SignalRServiceUsage values.

func NewSignalRServiceUsageListIterator 

func NewSignalRServiceUsageListIterator(page SignalRServiceUsageListPage) SignalRServiceUsageListIterator

Creates a new instance of the SignalRServiceUsageListIterator type.

func (*SignalRServiceUsageListIterator) Next 

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

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

func (iter SignalRServiceUsageListIterator) NotDone() bool

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

func (SignalRServiceUsageListIterator) Response 

func (iter SignalRServiceUsageListIterator) Response() SignalRServiceUsageList

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

func (SignalRServiceUsageListIterator) Value 

func (iter SignalRServiceUsageListIterator) Value() SignalRServiceUsage

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

type SignalRServiceUsageListPage 

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

SignalRServiceUsageListPage contains a page of SignalRServiceUsage values.

func NewSignalRServiceUsageListPage 

func NewSignalRServiceUsageListPage(cur SignalRServiceUsageList, getNextPage func(context.Context, SignalRServiceUsageList) (SignalRServiceUsageList, error)) SignalRServiceUsageListPage

Creates a new instance of the SignalRServiceUsageListPage type.

func (*SignalRServiceUsageListPage) Next 

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

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

func (page SignalRServiceUsageListPage) NotDone() bool

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

func (SignalRServiceUsageListPage) Response 

func (page SignalRServiceUsageListPage) Response() SignalRServiceUsageList

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

func (SignalRServiceUsageListPage) Values 

func (page SignalRServiceUsageListPage) Values() []SignalRServiceUsage

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

type SignalRServiceUsageName 

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

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

type SkuTier 

type SkuTier string

SkuTier enumerates the values for sku tier. 

const (
	// SkuTierBasic ...
	SkuTierBasic SkuTier = "Basic"
	// SkuTierFree ...
	SkuTierFree SkuTier = "Free"
	// SkuTierPremium ...
	SkuTierPremium SkuTier = "Premium"
	// SkuTierStandard ...
	SkuTierStandard SkuTier = "Standard"
)

func PossibleSkuTierValues 

func PossibleSkuTierValues() []SkuTier

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

type SystemData 

type SystemData struct {
	// CreatedBy - The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`
	// CreatedByType - The type of identity that created the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
	CreatedByType CreatedByType `json:"createdByType,omitempty"`
	// CreatedAt - The timestamp of resource creation (UTC).
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// LastModifiedBy - The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
	// LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
	LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"`
	// LastModifiedAt - The timestamp of resource last modification (UTC)
	LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}

SystemData metadata pertaining to creation and last modification of the resource.

type TLSSettings 

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

TLSSettings TLS settings for the resource

type TrackedResource 

type TrackedResource struct {
	// Location - The GEO location of the resource. 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 

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

MarshalJSON is the custom marshaler for TrackedResource.

type UpdateFuture 

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.

func (*UpdateFuture) UnmarshalJSON 

func (future *UpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type UpstreamAuthSettings 

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 

type UpstreamAuthType string

UpstreamAuthType enumerates the values for upstream auth type. 

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

func PossibleUpstreamAuthTypeValues 

func PossibleUpstreamAuthTypeValues() []UpstreamAuthType

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

type UsagesClient 

type UsagesClient struct {
	BaseClient
}

UsagesClient is the REST API for Azure WebPubSub Service

func NewUsagesClient 

func NewUsagesClient(subscriptionID string) UsagesClient

NewUsagesClient creates an instance of the UsagesClient client.

func NewUsagesClientWithBaseURI 

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 

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

List list resource usage quotas by location. Parameters: location - the location like "eastus"

func (UsagesClient) ListComplete 

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

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

func (UsagesClient) ListPreparer 

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

ListPreparer prepares the List request.

func (UsagesClient) ListResponder 

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

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

func (UsagesClient) ListSender 

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 

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.

func (UserAssignedIdentityProperty) MarshalJSON 

func (uaip UserAssignedIdentityProperty) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UserAssignedIdentityProperty.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.