relay

package
v40.3.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Mar 10, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package relay implements the Azure ARM Relay service API version 2017-04-01.

Use these API to manage Azure Relay resources through Azure Resource Manager.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Relay
	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 AccessKeys 

type AccessKeys struct {
	autorest.Response `json:"-"`
	// PrimaryConnectionString - Primary connection string of the created namespace authorization rule.
	PrimaryConnectionString *string `json:"primaryConnectionString,omitempty"`
	// SecondaryConnectionString - Secondary connection string of the created namespace authorization rule.
	SecondaryConnectionString *string `json:"secondaryConnectionString,omitempty"`
	// PrimaryKey - A base64-encoded 256-bit primary key for signing and validating the SAS token.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - A base64-encoded 256-bit secondary key for signing and validating the SAS token.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
	// KeyName - A string that describes the authorization rule.
	KeyName *string `json:"keyName,omitempty"`
}

AccessKeys namespace/Relay Connection String

type AccessRights 

type AccessRights string

AccessRights enumerates the values for access rights. 

const (
	// Listen ...
	Listen AccessRights = "Listen"
	// Manage ...
	Manage AccessRights = "Manage"
	// Send ...
	Send AccessRights = "Send"
)

func PossibleAccessRightsValues 

func PossibleAccessRightsValues() []AccessRights

PossibleAccessRightsValues returns an array of possible values for the AccessRights const type.

type AuthorizationRule 

type AuthorizationRule struct {
	autorest.Response `json:"-"`
	// AuthorizationRuleProperties - Authorization rule properties.
	*AuthorizationRuleProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

AuthorizationRule description of a namespace authorization rule.

func (AuthorizationRule) MarshalJSON 

func (ar AuthorizationRule) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AuthorizationRule.

func (*AuthorizationRule) UnmarshalJSON 

func (ar *AuthorizationRule) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AuthorizationRule struct.

type AuthorizationRuleListResult 

type AuthorizationRuleListResult struct {
	autorest.Response `json:"-"`
	// Value - Result of the list authorization rules operation.
	Value *[]AuthorizationRule `json:"value,omitempty"`
	// NextLink - Link to the next set of results. Not empty if value contains incomplete list of authorization rules.
	NextLink *string `json:"nextLink,omitempty"`
}

AuthorizationRuleListResult the response from the list namespace operation.

func (AuthorizationRuleListResult) IsEmpty 

func (arlr AuthorizationRuleListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AuthorizationRuleListResultIterator 

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

AuthorizationRuleListResultIterator provides access to a complete listing of AuthorizationRule values.

func NewAuthorizationRuleListResultIterator 

func NewAuthorizationRuleListResultIterator(page AuthorizationRuleListResultPage) AuthorizationRuleListResultIterator

Creates a new instance of the AuthorizationRuleListResultIterator type.

func (*AuthorizationRuleListResultIterator) Next 

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

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

func (iter AuthorizationRuleListResultIterator) NotDone() bool

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

func (AuthorizationRuleListResultIterator) Response 

func (iter AuthorizationRuleListResultIterator) Response() AuthorizationRuleListResult

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

func (AuthorizationRuleListResultIterator) Value 

func (iter AuthorizationRuleListResultIterator) Value() AuthorizationRule

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

type AuthorizationRuleListResultPage 

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

AuthorizationRuleListResultPage contains a page of AuthorizationRule values.

func NewAuthorizationRuleListResultPage 

func NewAuthorizationRuleListResultPage(getNextPage func(context.Context, AuthorizationRuleListResult) (AuthorizationRuleListResult, error)) AuthorizationRuleListResultPage

Creates a new instance of the AuthorizationRuleListResultPage type.

func (*AuthorizationRuleListResultPage) Next 

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

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

func (page AuthorizationRuleListResultPage) NotDone() bool

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

func (AuthorizationRuleListResultPage) Response 

func (page AuthorizationRuleListResultPage) Response() AuthorizationRuleListResult

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

func (AuthorizationRuleListResultPage) Values 

func (page AuthorizationRuleListResultPage) Values() []AuthorizationRule

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

type AuthorizationRuleProperties 

type AuthorizationRuleProperties struct {
	// Rights - The rights associated with the rule.
	Rights *[]AccessRights `json:"rights,omitempty"`
}

AuthorizationRuleProperties authorization rule properties.

type BaseClient 

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

BaseClient is the base client for Relay.

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 CheckNameAvailability 

type CheckNameAvailability struct {
	// Name - The namespace name to check for availability. The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number.
	Name *string `json:"name,omitempty"`
}

CheckNameAvailability description of the check name availability request properties.

type CheckNameAvailabilityResult 

type CheckNameAvailabilityResult struct {
	autorest.Response `json:"-"`
	// Message - READ-ONLY; The detailed info regarding the reason associated with the namespace.
	Message *string `json:"message,omitempty"`
	// NameAvailable - Value indicating namespace is available. Returns true if the namespace is available; otherwise, false.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Reason - The reason for unavailability of a namespace. Possible values include: 'None', 'InvalidName', 'SubscriptionIsDisabled', 'NameInUse', 'NameInLockdown', 'TooManyNamespaceInCurrentSubscription'
	Reason UnavailableReason `json:"reason,omitempty"`
}

CheckNameAvailabilityResult description of the check name availability request properties.

type ErrorResponse 

type ErrorResponse struct {
	// Code - Error code.
	Code *string `json:"code,omitempty"`
	// Message - Error message indicating why the operation failed.
	Message *string `json:"message,omitempty"`
}

ErrorResponse error reponse indicates Relay service is not able to process the incoming request. The reason is provided in the error message.

type HybridConnection 

type HybridConnection struct {
	autorest.Response `json:"-"`
	// HybridConnectionProperties - Properties of the HybridConnection.
	*HybridConnectionProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

HybridConnection description of hybrid connection resource.

func (HybridConnection) MarshalJSON 

func (hc HybridConnection) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HybridConnection.

func (*HybridConnection) UnmarshalJSON 

func (hc *HybridConnection) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for HybridConnection struct.

type HybridConnectionListResult 

type HybridConnectionListResult struct {
	autorest.Response `json:"-"`
	// Value - Result of the list hybrid connections.
	Value *[]HybridConnection `json:"value,omitempty"`
	// NextLink - Link to the next set of results. Not empty if value contains incomplete list hybrid connection operation.
	NextLink *string `json:"nextLink,omitempty"`
}

HybridConnectionListResult the response of the list hybrid connection operation.

func (HybridConnectionListResult) IsEmpty 

func (hclr HybridConnectionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type HybridConnectionListResultIterator 

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

HybridConnectionListResultIterator provides access to a complete listing of HybridConnection values.

func NewHybridConnectionListResultIterator 

func NewHybridConnectionListResultIterator(page HybridConnectionListResultPage) HybridConnectionListResultIterator

Creates a new instance of the HybridConnectionListResultIterator type.

func (*HybridConnectionListResultIterator) Next 

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

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

func (iter HybridConnectionListResultIterator) NotDone() bool

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

func (HybridConnectionListResultIterator) Response 

func (iter HybridConnectionListResultIterator) Response() HybridConnectionListResult

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

func (HybridConnectionListResultIterator) Value 

func (iter HybridConnectionListResultIterator) Value() HybridConnection

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

type HybridConnectionListResultPage 

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

HybridConnectionListResultPage contains a page of HybridConnection values.

func NewHybridConnectionListResultPage 

func NewHybridConnectionListResultPage(getNextPage func(context.Context, HybridConnectionListResult) (HybridConnectionListResult, error)) HybridConnectionListResultPage

Creates a new instance of the HybridConnectionListResultPage type.

func (*HybridConnectionListResultPage) Next 

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

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

func (page HybridConnectionListResultPage) NotDone() bool

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

func (HybridConnectionListResultPage) Response 

func (page HybridConnectionListResultPage) Response() HybridConnectionListResult

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

func (HybridConnectionListResultPage) Values 

func (page HybridConnectionListResultPage) Values() []HybridConnection

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

type HybridConnectionProperties 

type HybridConnectionProperties struct {
	// CreatedAt - READ-ONLY; The time the hybrid connection was created.
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// UpdatedAt - READ-ONLY; The time the namespace was updated.
	UpdatedAt *date.Time `json:"updatedAt,omitempty"`
	// ListenerCount - READ-ONLY; The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
	ListenerCount *int32 `json:"listenerCount,omitempty"`
	// RequiresClientAuthorization - Returns true if client authorization is needed for this hybrid connection; otherwise, false.
	RequiresClientAuthorization *bool `json:"requiresClientAuthorization,omitempty"`
	// UserMetadata - The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
	UserMetadata *string `json:"userMetadata,omitempty"`
}

HybridConnectionProperties properties of the HybridConnection.

type HybridConnectionsClient 

type HybridConnectionsClient struct {
	BaseClient
}

HybridConnectionsClient is the use these API to manage Azure Relay resources through Azure Resource Manager.

func NewHybridConnectionsClient 

func NewHybridConnectionsClient(subscriptionID string) HybridConnectionsClient

NewHybridConnectionsClient creates an instance of the HybridConnectionsClient client.

func NewHybridConnectionsClientWithBaseURI 

func NewHybridConnectionsClientWithBaseURI(baseURI string, subscriptionID string) HybridConnectionsClient

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

func (client HybridConnectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, parameters HybridConnection) (result HybridConnection, err error)

CreateOrUpdate creates or updates a service hybrid connection. This operation is idempotent. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name hybridConnectionName - the hybrid connection name. parameters - parameters supplied to create a hybrid connection.

func (HybridConnectionsClient) CreateOrUpdateAuthorizationRule 

func (client HybridConnectionsClient) CreateOrUpdateAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string, parameters AuthorizationRule) (result AuthorizationRule, err error)

CreateOrUpdateAuthorizationRule creates or updates an authorization rule for a hybrid connection. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name hybridConnectionName - the hybrid connection name. authorizationRuleName - the authorization rule name. parameters - the authorization rule parameters.

func (HybridConnectionsClient) CreateOrUpdateAuthorizationRulePreparer 

func (client HybridConnectionsClient) CreateOrUpdateAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string, parameters AuthorizationRule) (*http.Request, error)

CreateOrUpdateAuthorizationRulePreparer prepares the CreateOrUpdateAuthorizationRule request.

func (HybridConnectionsClient) CreateOrUpdateAuthorizationRuleResponder 

func (client HybridConnectionsClient) CreateOrUpdateAuthorizationRuleResponder(resp *http.Response) (result AuthorizationRule, err error)

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

func (HybridConnectionsClient) CreateOrUpdateAuthorizationRuleSender 

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

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

func (HybridConnectionsClient) CreateOrUpdatePreparer 

func (client HybridConnectionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, parameters HybridConnection) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (HybridConnectionsClient) CreateOrUpdateResponder 

func (client HybridConnectionsClient) CreateOrUpdateResponder(resp *http.Response) (result HybridConnection, err error)

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

func (HybridConnectionsClient) CreateOrUpdateSender 

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

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

func (HybridConnectionsClient) Delete 

func (client HybridConnectionsClient) Delete(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string) (result autorest.Response, err error)

Delete deletes a hybrid connection. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name hybridConnectionName - the hybrid connection name.

func (HybridConnectionsClient) DeleteAuthorizationRule 

func (client HybridConnectionsClient) DeleteAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string) (result autorest.Response, err error)

DeleteAuthorizationRule deletes a hybrid connection authorization rule. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name hybridConnectionName - the hybrid connection name. authorizationRuleName - the authorization rule name.

func (HybridConnectionsClient) DeleteAuthorizationRulePreparer 

func (client HybridConnectionsClient) DeleteAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string) (*http.Request, error)

DeleteAuthorizationRulePreparer prepares the DeleteAuthorizationRule request.

func (HybridConnectionsClient) DeleteAuthorizationRuleResponder 

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

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

func (HybridConnectionsClient) DeleteAuthorizationRuleSender 

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

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

func (HybridConnectionsClient) DeletePreparer 

func (client HybridConnectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (HybridConnectionsClient) DeleteResponder 

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

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

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

func (HybridConnectionsClient) Get 

func (client HybridConnectionsClient) Get(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string) (result HybridConnection, err error)

Get returns the description for the specified hybrid connection. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name hybridConnectionName - the hybrid connection name.

func (HybridConnectionsClient) GetAuthorizationRule 

func (client HybridConnectionsClient) GetAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string) (result AuthorizationRule, err error)

GetAuthorizationRule hybrid connection authorization rule for a hybrid connection by name. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name hybridConnectionName - the hybrid connection name. authorizationRuleName - the authorization rule name.

func (HybridConnectionsClient) GetAuthorizationRulePreparer 

func (client HybridConnectionsClient) GetAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string) (*http.Request, error)

GetAuthorizationRulePreparer prepares the GetAuthorizationRule request.

func (HybridConnectionsClient) GetAuthorizationRuleResponder 

func (client HybridConnectionsClient) GetAuthorizationRuleResponder(resp *http.Response) (result AuthorizationRule, err error)

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

func (HybridConnectionsClient) GetAuthorizationRuleSender 

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

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

func (HybridConnectionsClient) GetPreparer 

func (client HybridConnectionsClient) GetPreparer(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (HybridConnectionsClient) GetResponder 

func (client HybridConnectionsClient) GetResponder(resp *http.Response) (result HybridConnection, err error)

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

func (HybridConnectionsClient) GetSender 

func (client HybridConnectionsClient) 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 (HybridConnectionsClient) ListAuthorizationRules 

func (client HybridConnectionsClient) ListAuthorizationRules(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string) (result AuthorizationRuleListResultPage, err error)

ListAuthorizationRules authorization rules for a hybrid connection. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name hybridConnectionName - the hybrid connection name.

func (HybridConnectionsClient) ListAuthorizationRulesComplete 

func (client HybridConnectionsClient) ListAuthorizationRulesComplete(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string) (result AuthorizationRuleListResultIterator, err error)

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

func (HybridConnectionsClient) ListAuthorizationRulesPreparer 

func (client HybridConnectionsClient) ListAuthorizationRulesPreparer(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string) (*http.Request, error)

ListAuthorizationRulesPreparer prepares the ListAuthorizationRules request.

func (HybridConnectionsClient) ListAuthorizationRulesResponder 

func (client HybridConnectionsClient) ListAuthorizationRulesResponder(resp *http.Response) (result AuthorizationRuleListResult, err error)

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

func (HybridConnectionsClient) ListAuthorizationRulesSender 

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

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

func (HybridConnectionsClient) ListByNamespace 

func (client HybridConnectionsClient) ListByNamespace(ctx context.Context, resourceGroupName string, namespaceName string) (result HybridConnectionListResultPage, err error)

ListByNamespace lists the hybrid connection within the namespace. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name

func (HybridConnectionsClient) ListByNamespaceComplete 

func (client HybridConnectionsClient) ListByNamespaceComplete(ctx context.Context, resourceGroupName string, namespaceName string) (result HybridConnectionListResultIterator, err error)

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

func (HybridConnectionsClient) ListByNamespacePreparer 

func (client HybridConnectionsClient) ListByNamespacePreparer(ctx context.Context, resourceGroupName string, namespaceName string) (*http.Request, error)

ListByNamespacePreparer prepares the ListByNamespace request.

func (HybridConnectionsClient) ListByNamespaceResponder 

func (client HybridConnectionsClient) ListByNamespaceResponder(resp *http.Response) (result HybridConnectionListResult, err error)

ListByNamespaceResponder handles the response to the ListByNamespace request. The method always closes the http.Response Body.

func (HybridConnectionsClient) ListByNamespaceSender 

func (client HybridConnectionsClient) ListByNamespaceSender(req *http.Request) (*http.Response, error)

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

func (HybridConnectionsClient) ListKeys 

func (client HybridConnectionsClient) ListKeys(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string) (result AccessKeys, err error)

ListKeys primary and secondary connection strings to the hybrid connection. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name hybridConnectionName - the hybrid connection name. authorizationRuleName - the authorization rule name.

func (HybridConnectionsClient) ListKeysPreparer 

func (client HybridConnectionsClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (HybridConnectionsClient) ListKeysResponder 

func (client HybridConnectionsClient) ListKeysResponder(resp *http.Response) (result AccessKeys, err error)

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

func (HybridConnectionsClient) ListKeysSender 

func (client HybridConnectionsClient) 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 (HybridConnectionsClient) RegenerateKeys 

func (client HybridConnectionsClient) RegenerateKeys(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string, parameters RegenerateAccessKeyParameters) (result AccessKeys, err error)

RegenerateKeys regenerates the primary or secondary connection strings to the hybrid connection. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name hybridConnectionName - the hybrid connection name. authorizationRuleName - the authorization rule name. parameters - parameters supplied to regenerate authorization rule.

func (HybridConnectionsClient) RegenerateKeysPreparer 

func (client HybridConnectionsClient) RegenerateKeysPreparer(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string, parameters RegenerateAccessKeyParameters) (*http.Request, error)

RegenerateKeysPreparer prepares the RegenerateKeys request.

func (HybridConnectionsClient) RegenerateKeysResponder 

func (client HybridConnectionsClient) RegenerateKeysResponder(resp *http.Response) (result AccessKeys, err error)

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

func (HybridConnectionsClient) RegenerateKeysSender 

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

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

type KeyType 

type KeyType string

KeyType enumerates the values for key type. 

const (
	// PrimaryKey ...
	PrimaryKey KeyType = "PrimaryKey"
	// SecondaryKey ...
	SecondaryKey KeyType = "SecondaryKey"
)

func PossibleKeyTypeValues 

func PossibleKeyTypeValues() []KeyType

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

type Namespace 

type Namespace struct {
	autorest.Response `json:"-"`
	// Sku - SKU of the namespace.
	Sku *Sku `json:"sku,omitempty"`
	// NamespaceProperties - Description of Relay namespace
	*NamespaceProperties `json:"properties,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

Namespace description of a namespace resource.

func (Namespace) MarshalJSON 

func (n Namespace) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Namespace.

func (*Namespace) UnmarshalJSON 

func (n *Namespace) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Namespace struct.

type NamespaceListResult 

type NamespaceListResult struct {
	autorest.Response `json:"-"`
	// Value - Result of the list namespace operation.
	Value *[]Namespace `json:"value,omitempty"`
	// NextLink - Link to the next set of results. Not empty if value contains incomplete list of namespaces.
	NextLink *string `json:"nextLink,omitempty"`
}

NamespaceListResult the response from the list namespace operation.

func (NamespaceListResult) IsEmpty 

func (nlr NamespaceListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type NamespaceListResultIterator 

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

NamespaceListResultIterator provides access to a complete listing of Namespace values.

func NewNamespaceListResultIterator 

func NewNamespaceListResultIterator(page NamespaceListResultPage) NamespaceListResultIterator

Creates a new instance of the NamespaceListResultIterator type.

func (*NamespaceListResultIterator) Next 

func (iter *NamespaceListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*NamespaceListResultIterator) NextWithContext 

func (iter *NamespaceListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (NamespaceListResultIterator) NotDone 

func (iter NamespaceListResultIterator) NotDone() bool

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

func (NamespaceListResultIterator) Response 

func (iter NamespaceListResultIterator) Response() NamespaceListResult

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

func (NamespaceListResultIterator) Value 

func (iter NamespaceListResultIterator) Value() Namespace

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

type NamespaceListResultPage 

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

NamespaceListResultPage contains a page of Namespace values.

func NewNamespaceListResultPage 

func NewNamespaceListResultPage(getNextPage func(context.Context, NamespaceListResult) (NamespaceListResult, error)) NamespaceListResultPage

Creates a new instance of the NamespaceListResultPage type.

func (*NamespaceListResultPage) Next 

func (page *NamespaceListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*NamespaceListResultPage) NextWithContext 

func (page *NamespaceListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (NamespaceListResultPage) NotDone 

func (page NamespaceListResultPage) NotDone() bool

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

func (NamespaceListResultPage) Response 

func (page NamespaceListResultPage) Response() NamespaceListResult

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

func (NamespaceListResultPage) Values 

func (page NamespaceListResultPage) Values() []Namespace

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

type NamespaceProperties 

type NamespaceProperties struct {
	// ProvisioningState - READ-ONLY; Possible values include: 'Created', 'Succeeded', 'Deleted', 'Failed', 'Updating', 'Unknown'
	ProvisioningState ProvisioningStateEnum `json:"provisioningState,omitempty"`
	// CreatedAt - READ-ONLY; The time the namespace was created.
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// UpdatedAt - READ-ONLY; The time the namespace was updated.
	UpdatedAt *date.Time `json:"updatedAt,omitempty"`
	// ServiceBusEndpoint - READ-ONLY; Endpoint you can use to perform Service Bus operations.
	ServiceBusEndpoint *string `json:"serviceBusEndpoint,omitempty"`
	// MetricID - READ-ONLY; Identifier for Azure Insights metrics.
	MetricID *string `json:"metricId,omitempty"`
}

NamespaceProperties properties of the namespace.

type NamespacesClient 

type NamespacesClient struct {
	BaseClient
}

NamespacesClient is the use these API to manage Azure Relay resources through Azure Resource Manager.

func NewNamespacesClient 

func NewNamespacesClient(subscriptionID string) NamespacesClient

NewNamespacesClient creates an instance of the NamespacesClient client.

func NewNamespacesClientWithBaseURI 

func NewNamespacesClientWithBaseURI(baseURI string, subscriptionID string) NamespacesClient

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

func (NamespacesClient) CheckNameAvailabilityMethod 

func (client NamespacesClient) CheckNameAvailabilityMethod(ctx context.Context, parameters CheckNameAvailability) (result CheckNameAvailabilityResult, err error)

CheckNameAvailabilityMethod check the specified namespace name availability. Parameters: parameters - parameters to check availability of the specified namespace name.

func (NamespacesClient) CheckNameAvailabilityMethodPreparer 

func (client NamespacesClient) CheckNameAvailabilityMethodPreparer(ctx context.Context, parameters CheckNameAvailability) (*http.Request, error)

CheckNameAvailabilityMethodPreparer prepares the CheckNameAvailabilityMethod request.

func (NamespacesClient) CheckNameAvailabilityMethodResponder 

func (client NamespacesClient) CheckNameAvailabilityMethodResponder(resp *http.Response) (result CheckNameAvailabilityResult, err error)

CheckNameAvailabilityMethodResponder handles the response to the CheckNameAvailabilityMethod request. The method always closes the http.Response Body.

func (NamespacesClient) CheckNameAvailabilityMethodSender 

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

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

func (NamespacesClient) CreateOrUpdate 

func (client NamespacesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, namespaceName string, parameters Namespace) (result NamespacesCreateOrUpdateFuture, err error)

CreateOrUpdate create Azure Relay namespace. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name parameters - parameters supplied to create a namespace resource.

func (NamespacesClient) CreateOrUpdateAuthorizationRule 

func (client NamespacesClient) CreateOrUpdateAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string, parameters AuthorizationRule) (result AuthorizationRule, err error)

CreateOrUpdateAuthorizationRule creates or updates an authorization rule for a namespace. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name authorizationRuleName - the authorization rule name. parameters - the authorization rule parameters.

func (NamespacesClient) CreateOrUpdateAuthorizationRulePreparer 

func (client NamespacesClient) CreateOrUpdateAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string, parameters AuthorizationRule) (*http.Request, error)

CreateOrUpdateAuthorizationRulePreparer prepares the CreateOrUpdateAuthorizationRule request.

func (NamespacesClient) CreateOrUpdateAuthorizationRuleResponder 

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

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

func (NamespacesClient) CreateOrUpdateAuthorizationRuleSender 

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

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

func (NamespacesClient) CreateOrUpdatePreparer 

func (client NamespacesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, namespaceName string, parameters Namespace) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (NamespacesClient) CreateOrUpdateResponder 

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

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

func (NamespacesClient) CreateOrUpdateSender 

func (client NamespacesClient) CreateOrUpdateSender(req *http.Request) (future NamespacesCreateOrUpdateFuture, err error)

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

func (NamespacesClient) Delete 

func (client NamespacesClient) Delete(ctx context.Context, resourceGroupName string, namespaceName string) (result NamespacesDeleteFuture, err error)

Delete deletes an existing namespace. This operation also removes all associated resources under the namespace. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name

func (NamespacesClient) DeleteAuthorizationRule 

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

DeleteAuthorizationRule deletes a namespace authorization rule. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name authorizationRuleName - the authorization rule name.

func (NamespacesClient) DeleteAuthorizationRulePreparer 

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

DeleteAuthorizationRulePreparer prepares the DeleteAuthorizationRule request.

func (NamespacesClient) DeleteAuthorizationRuleResponder 

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

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

func (NamespacesClient) DeleteAuthorizationRuleSender 

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

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

func (NamespacesClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (NamespacesClient) DeleteResponder 

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

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

func (NamespacesClient) DeleteSender 

func (client NamespacesClient) DeleteSender(req *http.Request) (future NamespacesDeleteFuture, err error)

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

func (NamespacesClient) Get 

func (client NamespacesClient) Get(ctx context.Context, resourceGroupName string, namespaceName string) (result Namespace, err error)

Get returns the description for the specified namespace. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name

func (NamespacesClient) GetAuthorizationRule 

func (client NamespacesClient) GetAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string) (result AuthorizationRule, err error)

GetAuthorizationRule authorization rule for a namespace by name. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name authorizationRuleName - the authorization rule name.

func (NamespacesClient) GetAuthorizationRulePreparer 

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

GetAuthorizationRulePreparer prepares the GetAuthorizationRule request.

func (NamespacesClient) GetAuthorizationRuleResponder 

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

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

func (NamespacesClient) GetAuthorizationRuleSender 

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

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

func (NamespacesClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (NamespacesClient) GetResponder 

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

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

func (NamespacesClient) GetSender 

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

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

func (NamespacesClient) List 

func (client NamespacesClient) List(ctx context.Context) (result NamespaceListResultPage, err error)

List lists all the available namespaces within the subscription regardless of the resourceGroups.

func (NamespacesClient) ListAuthorizationRules 

func (client NamespacesClient) ListAuthorizationRules(ctx context.Context, resourceGroupName string, namespaceName string) (result AuthorizationRuleListResultPage, err error)

ListAuthorizationRules authorization rules for a namespace. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name

func (NamespacesClient) ListAuthorizationRulesComplete 

func (client NamespacesClient) ListAuthorizationRulesComplete(ctx context.Context, resourceGroupName string, namespaceName string) (result AuthorizationRuleListResultIterator, err error)

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

func (NamespacesClient) ListAuthorizationRulesPreparer 

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

ListAuthorizationRulesPreparer prepares the ListAuthorizationRules request.

func (NamespacesClient) ListAuthorizationRulesResponder 

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

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

func (NamespacesClient) ListAuthorizationRulesSender 

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

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

func (NamespacesClient) ListByResourceGroup 

func (client NamespacesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result NamespaceListResultPage, err error)

ListByResourceGroup lists all the available namespaces within the ResourceGroup. Parameters: resourceGroupName - name of the Resource group within the Azure subscription.

func (NamespacesClient) ListByResourceGroupComplete 

func (client NamespacesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result NamespaceListResultIterator, err error)

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

func (NamespacesClient) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (NamespacesClient) ListByResourceGroupResponder 

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

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

func (NamespacesClient) ListByResourceGroupSender 

func (client NamespacesClient) 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 (NamespacesClient) ListComplete 

func (client NamespacesClient) ListComplete(ctx context.Context) (result NamespaceListResultIterator, err error)

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

func (NamespacesClient) ListKeys 

func (client NamespacesClient) ListKeys(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string) (result AccessKeys, err error)

ListKeys primary and secondary connection strings to the namespace. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name authorizationRuleName - the authorization rule name.

func (NamespacesClient) ListKeysPreparer 

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

ListKeysPreparer prepares the ListKeys request.

func (NamespacesClient) ListKeysResponder 

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

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

func (NamespacesClient) ListKeysSender 

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

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

func (NamespacesClient) ListPreparer 

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

ListPreparer prepares the List request.

func (NamespacesClient) ListResponder 

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

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

func (NamespacesClient) ListSender 

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

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

func (NamespacesClient) RegenerateKeys 

func (client NamespacesClient) RegenerateKeys(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string, parameters RegenerateAccessKeyParameters) (result AccessKeys, err error)

RegenerateKeys regenerates the primary or secondary connection strings to the namespace. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name authorizationRuleName - the authorization rule name. parameters - parameters supplied to regenerate authorization rule.

func (NamespacesClient) RegenerateKeysPreparer 

func (client NamespacesClient) RegenerateKeysPreparer(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string, parameters RegenerateAccessKeyParameters) (*http.Request, error)

RegenerateKeysPreparer prepares the RegenerateKeys request.

func (NamespacesClient) RegenerateKeysResponder 

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

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

func (NamespacesClient) RegenerateKeysSender 

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

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

func (NamespacesClient) Update 

func (client NamespacesClient) Update(ctx context.Context, resourceGroupName string, namespaceName string, parameters UpdateParameters) (result Namespace, err error)

Update creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name parameters - parameters for updating a namespace resource.

func (NamespacesClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (NamespacesClient) UpdateResponder 

func (client NamespacesClient) UpdateResponder(resp *http.Response) (result Namespace, err error)

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

func (NamespacesClient) UpdateSender 

func (client NamespacesClient) 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 NamespacesCreateOrUpdateFuture 

type NamespacesCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*NamespacesCreateOrUpdateFuture) Result 

func (future *NamespacesCreateOrUpdateFuture) Result(client NamespacesClient) (n Namespace, err error)

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

type NamespacesDeleteFuture 

type NamespacesDeleteFuture struct {
	azure.Future
}

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

func (*NamespacesDeleteFuture) Result 

func (future *NamespacesDeleteFuture) Result(client NamespacesClient) (ar autorest.Response, err error)

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

type Operation 

type Operation struct {
	// Name - READ-ONLY; Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
	// Display - The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation a Relay REST API operation.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - READ-ONLY; Service provider: Relay.
	Provider *string `json:"provider,omitempty"`
	// Resource - READ-ONLY; Resource on which the operation is performed: Invoice, etc.
	Resource *string `json:"resource,omitempty"`
	// Operation - READ-ONLY; Operation type: Read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`
}

OperationDisplay the object that represents the operation.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of Relay operations supported by resource provider.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - READ-ONLY; URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult result of the request to list Relay operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator 

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next 

func (iter *OperationListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultIterator) NextWithContext 

func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListResultIterator) NotDone 

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

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

type OperationListResultPage 

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage 

func NewOperationListResultPage(getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next 

func (page *OperationListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultPage) NextWithContext 

func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListResultPage) NotDone 

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

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

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the use these API to manage Azure Relay resources through Azure Resource Manager.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

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

func (OperationsClient) List 

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

List lists all available Relay REST API operations.

func (OperationsClient) ListComplete 

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

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

func (OperationsClient) ListPreparer 

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 OperationListResult, 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 ProvisioningStateEnum 

type ProvisioningStateEnum string

ProvisioningStateEnum enumerates the values for provisioning state enum. 

const (
	// Created ...
	Created ProvisioningStateEnum = "Created"
	// Deleted ...
	Deleted ProvisioningStateEnum = "Deleted"
	// Failed ...
	Failed ProvisioningStateEnum = "Failed"
	// Succeeded ...
	Succeeded ProvisioningStateEnum = "Succeeded"
	// Unknown ...
	Unknown ProvisioningStateEnum = "Unknown"
	// Updating ...
	Updating ProvisioningStateEnum = "Updating"
)

func PossibleProvisioningStateEnumValues 

func PossibleProvisioningStateEnumValues() []ProvisioningStateEnum

PossibleProvisioningStateEnumValues returns an array of possible values for the ProvisioningStateEnum const type.

type RegenerateAccessKeyParameters 

type RegenerateAccessKeyParameters struct {
	// KeyType - The access key to regenerate. Possible values include: 'PrimaryKey', 'SecondaryKey'
	KeyType KeyType `json:"keyType,omitempty"`
	// Key - Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type.
	Key *string `json:"key,omitempty"`
}

RegenerateAccessKeyParameters parameters supplied to the regenerate authorization rule operation, specifies which key neeeds to be reset.

type RelaytypeEnum 

type RelaytypeEnum string

RelaytypeEnum enumerates the values for relaytype enum. 

const (
	// HTTP ...
	HTTP RelaytypeEnum = "Http"
	// NetTCP ...
	NetTCP RelaytypeEnum = "NetTcp"
)

func PossibleRelaytypeEnumValues 

func PossibleRelaytypeEnumValues() []RelaytypeEnum

PossibleRelaytypeEnumValues returns an array of possible values for the RelaytypeEnum const type.

type Resource 

type Resource struct {
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

Resource the resource definition.

type ResourceNamespacePatch 

type ResourceNamespacePatch struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

ResourceNamespacePatch definition of resource.

func (ResourceNamespacePatch) MarshalJSON 

func (rnp ResourceNamespacePatch) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceNamespacePatch.

type Sku 

type Sku struct {
	// Name - Name of this SKU.
	Name *string `json:"name,omitempty"`
	// Tier - The tier of this SKU. Possible values include: 'Standard'
	Tier SkuTier `json:"tier,omitempty"`
}

Sku SKU of the namespace.

type SkuTier 

type SkuTier string

SkuTier enumerates the values for sku tier. 

const (
	// Standard ...
	Standard SkuTier = "Standard"
)

func PossibleSkuTierValues 

func PossibleSkuTierValues() []SkuTier

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

type TrackedResource 

type TrackedResource struct {
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

TrackedResource definition of resource.

func (TrackedResource) MarshalJSON 

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

MarshalJSON is the custom marshaler for TrackedResource.

type UnavailableReason 

type UnavailableReason string

UnavailableReason enumerates the values for unavailable reason. 

const (
	// InvalidName ...
	InvalidName UnavailableReason = "InvalidName"
	// NameInLockdown ...
	NameInLockdown UnavailableReason = "NameInLockdown"
	// NameInUse ...
	NameInUse UnavailableReason = "NameInUse"
	// None ...
	None UnavailableReason = "None"
	// SubscriptionIsDisabled ...
	SubscriptionIsDisabled UnavailableReason = "SubscriptionIsDisabled"
	// TooManyNamespaceInCurrentSubscription ...
	TooManyNamespaceInCurrentSubscription UnavailableReason = "TooManyNamespaceInCurrentSubscription"
)

func PossibleUnavailableReasonValues 

func PossibleUnavailableReasonValues() []UnavailableReason

PossibleUnavailableReasonValues returns an array of possible values for the UnavailableReason const type.

type UpdateParameters 

type UpdateParameters struct {
	// Sku - SKU of the namespace.
	Sku *Sku `json:"sku,omitempty"`
	// NamespaceProperties - Description of Relay namespace.
	*NamespaceProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

UpdateParameters description of a namespace resource.

func (UpdateParameters) MarshalJSON 

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

MarshalJSON is the custom marshaler for UpdateParameters.

func (*UpdateParameters) UnmarshalJSON 

func (up *UpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UpdateParameters struct.

type WCFRelaysClient 

type WCFRelaysClient struct {
	BaseClient
}

WCFRelaysClient is the use these API to manage Azure Relay resources through Azure Resource Manager.

func NewWCFRelaysClient 

func NewWCFRelaysClient(subscriptionID string) WCFRelaysClient

NewWCFRelaysClient creates an instance of the WCFRelaysClient client.

func NewWCFRelaysClientWithBaseURI 

func NewWCFRelaysClientWithBaseURI(baseURI string, subscriptionID string) WCFRelaysClient

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

func (client WCFRelaysClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, parameters WcfRelay) (result WcfRelay, err error)

CreateOrUpdate creates or updates a WCF relay. This operation is idempotent. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name relayName - the relay name. parameters - parameters supplied to create a WCF relay.

func (WCFRelaysClient) CreateOrUpdateAuthorizationRule 

func (client WCFRelaysClient) CreateOrUpdateAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string, parameters AuthorizationRule) (result AuthorizationRule, err error)

CreateOrUpdateAuthorizationRule creates or updates an authorization rule for a WCF relay. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name relayName - the relay name. authorizationRuleName - the authorization rule name. parameters - the authorization rule parameters.

func (WCFRelaysClient) CreateOrUpdateAuthorizationRulePreparer 

func (client WCFRelaysClient) CreateOrUpdateAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string, parameters AuthorizationRule) (*http.Request, error)

CreateOrUpdateAuthorizationRulePreparer prepares the CreateOrUpdateAuthorizationRule request.

func (WCFRelaysClient) CreateOrUpdateAuthorizationRuleResponder 

func (client WCFRelaysClient) CreateOrUpdateAuthorizationRuleResponder(resp *http.Response) (result AuthorizationRule, err error)

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

func (WCFRelaysClient) CreateOrUpdateAuthorizationRuleSender 

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

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

func (WCFRelaysClient) CreateOrUpdatePreparer 

func (client WCFRelaysClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, parameters WcfRelay) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (WCFRelaysClient) CreateOrUpdateResponder 

func (client WCFRelaysClient) CreateOrUpdateResponder(resp *http.Response) (result WcfRelay, err error)

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

func (WCFRelaysClient) CreateOrUpdateSender 

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

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

func (WCFRelaysClient) Delete 

func (client WCFRelaysClient) Delete(ctx context.Context, resourceGroupName string, namespaceName string, relayName string) (result autorest.Response, err error)

Delete deletes a WCF relay. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name relayName - the relay name.

func (WCFRelaysClient) DeleteAuthorizationRule 

func (client WCFRelaysClient) DeleteAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string) (result autorest.Response, err error)

DeleteAuthorizationRule deletes a WCF relay authorization rule. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name relayName - the relay name. authorizationRuleName - the authorization rule name.

func (WCFRelaysClient) DeleteAuthorizationRulePreparer 

func (client WCFRelaysClient) DeleteAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string) (*http.Request, error)

DeleteAuthorizationRulePreparer prepares the DeleteAuthorizationRule request.

func (WCFRelaysClient) DeleteAuthorizationRuleResponder 

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

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

func (WCFRelaysClient) DeleteAuthorizationRuleSender 

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

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

func (WCFRelaysClient) DeletePreparer 

func (client WCFRelaysClient) DeletePreparer(ctx context.Context, resourceGroupName string, namespaceName string, relayName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (WCFRelaysClient) DeleteResponder 

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

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

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

func (WCFRelaysClient) Get 

func (client WCFRelaysClient) Get(ctx context.Context, resourceGroupName string, namespaceName string, relayName string) (result WcfRelay, err error)

Get returns the description for the specified WCF relay. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name relayName - the relay name.

func (WCFRelaysClient) GetAuthorizationRule 

func (client WCFRelaysClient) GetAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string) (result AuthorizationRule, err error)

GetAuthorizationRule get authorizationRule for a WCF relay by name. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name relayName - the relay name. authorizationRuleName - the authorization rule name.

func (WCFRelaysClient) GetAuthorizationRulePreparer 

func (client WCFRelaysClient) GetAuthorizationRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string) (*http.Request, error)

GetAuthorizationRulePreparer prepares the GetAuthorizationRule request.

func (WCFRelaysClient) GetAuthorizationRuleResponder 

func (client WCFRelaysClient) GetAuthorizationRuleResponder(resp *http.Response) (result AuthorizationRule, err error)

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

func (WCFRelaysClient) GetAuthorizationRuleSender 

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

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

func (WCFRelaysClient) GetPreparer 

func (client WCFRelaysClient) GetPreparer(ctx context.Context, resourceGroupName string, namespaceName string, relayName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (WCFRelaysClient) GetResponder 

func (client WCFRelaysClient) GetResponder(resp *http.Response) (result WcfRelay, err error)

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

func (WCFRelaysClient) GetSender 

func (client WCFRelaysClient) 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 (WCFRelaysClient) ListAuthorizationRules 

func (client WCFRelaysClient) ListAuthorizationRules(ctx context.Context, resourceGroupName string, namespaceName string, relayName string) (result AuthorizationRuleListResultPage, err error)

ListAuthorizationRules authorization rules for a WCF relay. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name relayName - the relay name.

func (WCFRelaysClient) ListAuthorizationRulesComplete 

func (client WCFRelaysClient) ListAuthorizationRulesComplete(ctx context.Context, resourceGroupName string, namespaceName string, relayName string) (result AuthorizationRuleListResultIterator, err error)

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

func (WCFRelaysClient) ListAuthorizationRulesPreparer 

func (client WCFRelaysClient) ListAuthorizationRulesPreparer(ctx context.Context, resourceGroupName string, namespaceName string, relayName string) (*http.Request, error)

ListAuthorizationRulesPreparer prepares the ListAuthorizationRules request.

func (WCFRelaysClient) ListAuthorizationRulesResponder 

func (client WCFRelaysClient) ListAuthorizationRulesResponder(resp *http.Response) (result AuthorizationRuleListResult, err error)

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

func (WCFRelaysClient) ListAuthorizationRulesSender 

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

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

func (WCFRelaysClient) ListByNamespace 

func (client WCFRelaysClient) ListByNamespace(ctx context.Context, resourceGroupName string, namespaceName string) (result WcfRelaysListResultPage, err error)

ListByNamespace lists the WCF relays within the namespace. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name

func (WCFRelaysClient) ListByNamespaceComplete 

func (client WCFRelaysClient) ListByNamespaceComplete(ctx context.Context, resourceGroupName string, namespaceName string) (result WcfRelaysListResultIterator, err error)

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

func (WCFRelaysClient) ListByNamespacePreparer 

func (client WCFRelaysClient) ListByNamespacePreparer(ctx context.Context, resourceGroupName string, namespaceName string) (*http.Request, error)

ListByNamespacePreparer prepares the ListByNamespace request.

func (WCFRelaysClient) ListByNamespaceResponder 

func (client WCFRelaysClient) ListByNamespaceResponder(resp *http.Response) (result WcfRelaysListResult, err error)

ListByNamespaceResponder handles the response to the ListByNamespace request. The method always closes the http.Response Body.

func (WCFRelaysClient) ListByNamespaceSender 

func (client WCFRelaysClient) ListByNamespaceSender(req *http.Request) (*http.Response, error)

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

func (WCFRelaysClient) ListKeys 

func (client WCFRelaysClient) ListKeys(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string) (result AccessKeys, err error)

ListKeys primary and secondary connection strings to the WCF relay. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name relayName - the relay name. authorizationRuleName - the authorization rule name.

func (WCFRelaysClient) ListKeysPreparer 

func (client WCFRelaysClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (WCFRelaysClient) ListKeysResponder 

func (client WCFRelaysClient) ListKeysResponder(resp *http.Response) (result AccessKeys, err error)

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

func (WCFRelaysClient) ListKeysSender 

func (client WCFRelaysClient) 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 (WCFRelaysClient) RegenerateKeys 

func (client WCFRelaysClient) RegenerateKeys(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string, parameters RegenerateAccessKeyParameters) (result AccessKeys, err error)

RegenerateKeys regenerates the primary or secondary connection strings to the WCF relay. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. namespaceName - the namespace name relayName - the relay name. authorizationRuleName - the authorization rule name. parameters - parameters supplied to regenerate authorization rule.

func (WCFRelaysClient) RegenerateKeysPreparer 

func (client WCFRelaysClient) RegenerateKeysPreparer(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string, parameters RegenerateAccessKeyParameters) (*http.Request, error)

RegenerateKeysPreparer prepares the RegenerateKeys request.

func (WCFRelaysClient) RegenerateKeysResponder 

func (client WCFRelaysClient) RegenerateKeysResponder(resp *http.Response) (result AccessKeys, err error)

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

func (WCFRelaysClient) RegenerateKeysSender 

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

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

type WcfRelay 

type WcfRelay struct {
	autorest.Response `json:"-"`
	// WcfRelayProperties - Properties of the WCF relay.
	*WcfRelayProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

WcfRelay description of the WCF relay resource.

func (WcfRelay) MarshalJSON 

func (wr WcfRelay) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WcfRelay.

func (*WcfRelay) UnmarshalJSON 

func (wr *WcfRelay) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for WcfRelay struct.

type WcfRelayProperties 

type WcfRelayProperties struct {
	// IsDynamic - READ-ONLY; Returns true if the relay is dynamic; otherwise, false.
	IsDynamic *bool `json:"isDynamic,omitempty"`
	// CreatedAt - READ-ONLY; The time the WCF relay was created.
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// UpdatedAt - READ-ONLY; The time the namespace was updated.
	UpdatedAt *date.Time `json:"updatedAt,omitempty"`
	// ListenerCount - READ-ONLY; The number of listeners for this relay. Note that min :1 and max:25 are supported.
	ListenerCount *int32 `json:"listenerCount,omitempty"`
	// RelayType - WCF relay type. Possible values include: 'NetTCP', 'HTTP'
	RelayType RelaytypeEnum `json:"relayType,omitempty"`
	// RequiresClientAuthorization - Returns true if client authorization is needed for this relay; otherwise, false.
	RequiresClientAuthorization *bool `json:"requiresClientAuthorization,omitempty"`
	// RequiresTransportSecurity - Returns true if transport security is needed for this relay; otherwise, false.
	RequiresTransportSecurity *bool `json:"requiresTransportSecurity,omitempty"`
	// UserMetadata - The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.
	UserMetadata *string `json:"userMetadata,omitempty"`
}

WcfRelayProperties properties of the WCF relay.

type WcfRelaysListResult 

type WcfRelaysListResult struct {
	autorest.Response `json:"-"`
	// Value - Result of the list WCF relay operation.
	Value *[]WcfRelay `json:"value,omitempty"`
	// NextLink - Link to the next set of results. Not empty if value contains incomplete list of WCF relays.
	NextLink *string `json:"nextLink,omitempty"`
}

WcfRelaysListResult the response of the list WCF relay operation.

func (WcfRelaysListResult) IsEmpty 

func (wrlr WcfRelaysListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type WcfRelaysListResultIterator 

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

WcfRelaysListResultIterator provides access to a complete listing of WcfRelay values.

func NewWcfRelaysListResultIterator 

func NewWcfRelaysListResultIterator(page WcfRelaysListResultPage) WcfRelaysListResultIterator

Creates a new instance of the WcfRelaysListResultIterator type.

func (*WcfRelaysListResultIterator) Next 

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

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

func (iter WcfRelaysListResultIterator) NotDone() bool

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

func (WcfRelaysListResultIterator) Response 

func (iter WcfRelaysListResultIterator) Response() WcfRelaysListResult

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

func (WcfRelaysListResultIterator) Value 

func (iter WcfRelaysListResultIterator) Value() WcfRelay

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

type WcfRelaysListResultPage 

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

WcfRelaysListResultPage contains a page of WcfRelay values.

func NewWcfRelaysListResultPage 

func NewWcfRelaysListResultPage(getNextPage func(context.Context, WcfRelaysListResult) (WcfRelaysListResult, error)) WcfRelaysListResultPage

Creates a new instance of the WcfRelaysListResultPage type.

func (*WcfRelaysListResultPage) Next 

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

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

func (page WcfRelaysListResultPage) NotDone() bool

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

func (WcfRelaysListResultPage) Response 

func (page WcfRelaysListResultPage) Response() WcfRelaysListResult

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

func (WcfRelaysListResultPage) Values 

func (page WcfRelaysListResultPage) Values() []WcfRelay

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

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.