relay

package
v12.3.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Jan 30, 2018 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package relay implements the Azure ARM Relay service API version 2016-07-01.

Use these API to manage Azure Relay resources through Azure Resources 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 AccessRights 

type AccessRights string

AccessRights enumerates the values for access rights. 

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

type AuthorizationRule 

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

AuthorizationRule description of a Namespace AuthorizationRules.

func (*AuthorizationRule) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for AuthorizationRule struct.

type AuthorizationRuleKeys 

type AuthorizationRuleKeys struct {
	autorest.Response `json:"-"`
	// PrimaryConnectionString - PrimaryConnectionString of the created Namespace AuthorizationRule.
	PrimaryConnectionString *string `json:"primaryConnectionString,omitempty"`
	// SecondaryConnectionString - SecondaryConnectionString of the created Namespace AuthorizationRule
	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"`
}

AuthorizationRuleKeys namespace/Relay Connection String

type AuthorizationRuleListResult 

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

AuthorizationRuleListResult the response of 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 (*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.

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 (*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.

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

type CheckNameAvailability 

type CheckNameAvailability struct {
	// Name - The Name to check the namespce name availability and 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 a Check Name availability request properties.

type CheckNameAvailabilityResult 

type CheckNameAvailabilityResult struct {
	autorest.Response `json:"-"`
	// NameAvailable - Value indicating namespace is availability, 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"`
	// Message - The detailed info regarding the reason associated with the namespace.
	Message *string `json:"message,omitempty"`
}

CheckNameAvailabilityResult description of a 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:"-"`
	// ID - Resource Id
	ID *string `json:"id,omitempty"`
	// Name - Resource name
	Name *string `json:"name,omitempty"`
	// Type - Resource type
	Type *string `json:"type,omitempty"`
	// HybridConnectionProperties - Properties of HybridConnection
	*HybridConnectionProperties `json:"properties,omitempty"`
}

HybridConnection description of HybridConnection Resource.

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 HybridConnection .
	Value *[]HybridConnection `json:"value,omitempty"`
	// NextLink - Link to the next set of results. Not empty if Value contains incomplete list of HybridConnection operation
	NextLink *string `json:"nextLink,omitempty"`
}

HybridConnectionListResult the response of the List HybridConnection 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 (*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.

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 (*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.

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 - The time the HybridConnection was created.
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// UpdatedAt - The time the namespace was updated.
	UpdatedAt *date.Time `json:"updatedAt,omitempty"`
	// ListenerCount - The number of listeners for this HybridConnection. min : 1 and max:25 supported
	ListenerCount *int32 `json:"listenerCount,omitempty"`
	// RequiresClientAuthorization - true if client authorization is needed for this HybridConnection; otherwise, false.
	RequiresClientAuthorization *bool `json:"requiresClientAuthorization,omitempty"`
	// UserMetadata - usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. 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"`
}

HybridConnectionProperties properties of the HybridConnection.

type HybridConnectionsClient 

type HybridConnectionsClient struct {
	BaseClient
}

HybridConnectionsClient is the use these API to manage Azure Relay resources through Azure Resources 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.

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 HybridConnection. This operation is idempotent.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name hybridConnectionName is the hybrid connection name. parameters is parameters supplied to create a HybridConnection.

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 HybridConnection

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name hybridConnectionName is the hybrid connection name. authorizationRuleName is the authorizationRule name. parameters is 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 HybridConnection .

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name hybridConnectionName is 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 HybridConnection authorization rule

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name hybridConnectionName is the hybrid connection name. authorizationRuleName is the authorizationRule 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 HybridConnection.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name hybridConnectionName is 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 hybridConnection authorizationRule for a HybridConnection by name.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name hybridConnectionName is the hybrid connection name. authorizationRuleName is the authorizationRule 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 HybridConnection.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name hybridConnectionName is 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 HybridConnection within the namespace.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is 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 AuthorizationRuleKeys, err error)

ListKeys primary and Secondary ConnectionStrings to the HybridConnection.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name hybridConnectionName is the hybrid connection name. authorizationRuleName is the authorizationRule 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 AuthorizationRuleKeys, 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 RegenerateKeysParameters) (result AuthorizationRuleKeys, err error)

RegenerateKeys regenerates the Primary or Secondary ConnectionStrings to the HybridConnection

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name hybridConnectionName is the hybrid connection name. authorizationRuleName is the authorizationRule name. parameters is parameters supplied to regenerate Auth Rule.

func (HybridConnectionsClient) RegenerateKeysPreparer 

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

RegenerateKeysPreparer prepares the RegenerateKeys request.

func (HybridConnectionsClient) RegenerateKeysResponder 

func (client HybridConnectionsClient) RegenerateKeysResponder(resp *http.Response) (result AuthorizationRuleKeys, 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 Namespace 

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

Namespace description of a Namespace resource.

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 of the List Namespace operation.

func (NamespaceListResult) IsEmpty 

func (nlr NamespaceListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type NamespaceListResultIterator 

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

NamespaceListResultIterator provides access to a complete listing of Namespace values.

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.

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 (*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.

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 - Provisioning state of the namespace.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// CreatedAt - The time the namespace was created.
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// UpdatedAt - The time the namespace was updated.
	UpdatedAt *date.Time `json:"updatedAt,omitempty"`
	// ServiceBusEndpoint - Endpoint you can use to perform Service Bus operations.
	ServiceBusEndpoint *string `json:"serviceBusEndpoint,omitempty"`
	// MetricID - Identifier for Azure Insights metrics
	MetricID *string `json:"metricId,omitempty"`
}

NamespaceProperties properties of the Namespace.

type NamespaceUpdateParameter 

type NamespaceUpdateParameter struct {
	// Tags - Resource tags
	Tags *map[string]*string `json:"tags,omitempty"`
	// Sku - The sku of the created namespace
	Sku *Sku `json:"sku,omitempty"`
}

NamespaceUpdateParameter parameters supplied to the Patch Namespace operation.

type NamespacesClient 

type NamespacesClient struct {
	BaseClient
}

NamespacesClient is the use these API to manage Azure Relay resources through Azure Resources 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.

func (NamespacesClient) CheckNameAvailabilityMethod 

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

CheckNameAvailabilityMethod check the give namespace name availability.

parameters is parameters to check availability of the given 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.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name parameters is 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

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name authorizationRuleName is the authorizationRule name. parameters is 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.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is 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

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name authorizationRuleName is the authorizationRule 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.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is 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.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name authorizationRuleName is the authorizationRule 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 irrespective 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.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is 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.

resourceGroupName is 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 AuthorizationRuleKeys, err error)

ListKeys primary and Secondary ConnectionStrings to the namespace

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name authorizationRuleName is the authorizationRule 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 AuthorizationRuleKeys, 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 RegenerateKeysParameters) (result AuthorizationRuleKeys, err error)

RegenerateKeys regenerates the Primary or Secondary ConnectionStrings to the namespace

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name authorizationRuleName is the authorizationRule name. parameters is parameters supplied to regenerate Auth Rule.

func (NamespacesClient) RegenerateKeysPreparer 

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

RegenerateKeysPreparer prepares the RegenerateKeys request.

func (NamespacesClient) RegenerateKeysResponder 

func (client NamespacesClient) RegenerateKeysResponder(resp *http.Response) (result AuthorizationRuleKeys, 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 NamespaceUpdateParameter) (result Namespace, err error)

Update creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name parameters is parameters for updating a namespace resource.

func (NamespacesClient) UpdatePreparer 

func (client NamespacesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, namespaceName string, parameters NamespaceUpdateParameter) (*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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 - Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
	// Display - The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation a EventHub REST API operation

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Service provider: Microsoft.EventHub
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed: Invoice, etc.
	Resource *string `json:"resource,omitempty"`
	// Operation - 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 - List of EventHub operations supported by the Microsoft.EventHub resource provider.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - 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 EventHub 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 (*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.

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 (*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.

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

func (OperationsClient) List 

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

List lists all of the 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 PolicyKey 

type PolicyKey string

PolicyKey enumerates the values for policy key. 

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

type RegenerateKeysParameters 

type RegenerateKeysParameters struct {
	// PolicyKey - Key that needs to be regenerated. Possible values include: 'PrimaryKey', 'SecondaryKey'
	PolicyKey PolicyKey `json:"policyKey,omitempty"`
}

RegenerateKeysParameters parameters supplied to the Regenerate Authorization Rule operation.

type RelaytypeEnum 

type RelaytypeEnum string

RelaytypeEnum enumerates the values for relaytype enum. 

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

type Resource 

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

Resource the Resource definition

type Sku 

type Sku struct {
	// Name - Name of this Sku
	Name *string `json:"name,omitempty"`
	// Tier - The tier of this particular SKU
	Tier *string `json:"tier,omitempty"`
}

Sku sku of the Namespace.

type TrackedResource 

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

TrackedResource definition of Resource

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

type WCFRelaysClient 

type WCFRelaysClient struct {
	BaseClient
}

WCFRelaysClient is the use these API to manage Azure Relay resources through Azure Resources 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.

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 WCFRelay. This operation is idempotent.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name relayName is the relay name parameters is parameters supplied to create a WCFRelays.

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 WCFRelays

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name relayName is the relay name authorizationRuleName is the authorizationRule name. parameters is 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 WCFRelays .

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name relayName is 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 WCFRelays authorization rule

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name relayName is the relay name authorizationRuleName is the authorizationRule 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 WCFRelays.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name relayName is 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 WCFRelays by name.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name relayName is the relay name authorizationRuleName is the authorizationRule 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 WCFRelays.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name relayName is 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 WCFRelays within the namespace.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is 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 AuthorizationRuleKeys, err error)

ListKeys primary and Secondary ConnectionStrings to the WCFRelays.

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name relayName is the relay name authorizationRuleName is the authorizationRule 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 AuthorizationRuleKeys, 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 RegenerateKeysParameters) (result AuthorizationRuleKeys, err error)

RegenerateKeys regenerates the Primary or Secondary ConnectionStrings to the WCFRelays

resourceGroupName is name of the Resource group within the Azure subscription. namespaceName is the Namespace Name relayName is the relay name authorizationRuleName is the authorizationRule name. parameters is parameters supplied to regenerate Auth Rule.

func (WCFRelaysClient) RegenerateKeysPreparer 

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

RegenerateKeysPreparer prepares the RegenerateKeys request.

func (WCFRelaysClient) RegenerateKeysResponder 

func (client WCFRelaysClient) RegenerateKeysResponder(resp *http.Response) (result AuthorizationRuleKeys, 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:"-"`
	// ID - Resource Id
	ID *string `json:"id,omitempty"`
	// Name - Resource name
	Name *string `json:"name,omitempty"`
	// Type - Resource type
	Type *string `json:"type,omitempty"`
	// WcfRelayProperties - Properties of WcfRelay
	*WcfRelayProperties `json:"properties,omitempty"`
}

WcfRelay description of WcfRelays Resource.

func (*WcfRelay) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for WcfRelay struct.

type WcfRelayProperties 

type WcfRelayProperties struct {
	// RelayType - WCFRelay Type. Possible values include: 'NetTCP', 'HTTP'
	RelayType RelaytypeEnum `json:"relayType,omitempty"`
	// CreatedAt - The time the WCFRelay was created.
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// UpdatedAt - The time the namespace was updated.
	UpdatedAt *date.Time `json:"updatedAt,omitempty"`
	// ListenerCount - The number of listeners for this relay. min : 1 and max:25 supported
	ListenerCount *int32 `json:"listenerCount,omitempty"`
	// RequiresClientAuthorization - true if client authorization is needed for this relay; otherwise, false.
	RequiresClientAuthorization *bool `json:"requiresClientAuthorization,omitempty"`
	// RequiresTransportSecurity - true if transport security is needed for this relay; otherwise, false.
	RequiresTransportSecurity *bool `json:"requiresTransportSecurity,omitempty"`
	// IsDynamic - true if the relay is dynamic; otherwise, false.
	IsDynamic *bool `json:"isDynamic,omitempty"`
	// UserMetadata - usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. 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 WcfRelay Properties.

type WcfRelaysListResult 

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

WcfRelaysListResult the response of the List WcfRelays 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 (*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.

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 (*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.

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

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.