eventhub

package
v40.6.0+incompatible Latest Latest
Warning

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

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

Documentation

Overview

Package eventhub implements the Azure ARM Eventhub service API version 2018-01-01-preview.

Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.

Index

Constants

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

type AvailableCluster struct {
	// Location - Location fo the Available Cluster
	Location *string `json:"location,omitempty"`
}

AvailableCluster pre-provisioned and readily available Event Hubs Cluster count per region.

type AvailableClustersList

type AvailableClustersList struct {
	autorest.Response `json:"-"`
	// Value - The count of readily available and pre-provisioned Event Hubs Clusters per region.
	Value *[]AvailableCluster `json:"value,omitempty"`
}

AvailableClustersList the response of the List Available Clusters operation.

type BaseClient

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

BaseClient is the base client for Eventhub.

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 Cluster

type Cluster struct {
	autorest.Response `json:"-"`
	// Sku - Properties of the cluster SKU.
	Sku *ClusterSku `json:"sku,omitempty"`
	// ClusterProperties - Event Hubs Cluster properties supplied in responses in List or Get operations.
	*ClusterProperties `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"`
}

Cluster single Event Hubs Cluster resource in List or Get operations.

func (Cluster) MarshalJSON

func (c Cluster) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Cluster.

func (*Cluster) UnmarshalJSON

func (c *Cluster) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Cluster struct.

type ClusterListResult

type ClusterListResult struct {
	autorest.Response `json:"-"`
	// Value - The Event Hubs Clusters present in the List Event Hubs operation results.
	Value *[]Cluster `json:"value,omitempty"`
	// NextLink - Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters.
	NextLink *string `json:"nextLink,omitempty"`
}

ClusterListResult the response of the List Event Hubs Clusters operation.

func (ClusterListResult) IsEmpty

func (clr ClusterListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ClusterListResultIterator

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

ClusterListResultIterator provides access to a complete listing of Cluster values.

func NewClusterListResultIterator

func NewClusterListResultIterator(page ClusterListResultPage) ClusterListResultIterator

Creates a new instance of the ClusterListResultIterator type.

func (*ClusterListResultIterator) Next

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

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

func (iter ClusterListResultIterator) NotDone() bool

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

func (ClusterListResultIterator) Response

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

func (ClusterListResultIterator) Value

func (iter ClusterListResultIterator) Value() Cluster

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

type ClusterListResultPage

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

ClusterListResultPage contains a page of Cluster values.

func NewClusterListResultPage

func NewClusterListResultPage(getNextPage func(context.Context, ClusterListResult) (ClusterListResult, error)) ClusterListResultPage

Creates a new instance of the ClusterListResultPage type.

func (*ClusterListResultPage) Next

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

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

func (page ClusterListResultPage) NotDone() bool

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

func (ClusterListResultPage) Response

func (page ClusterListResultPage) Response() ClusterListResult

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

func (ClusterListResultPage) Values

func (page ClusterListResultPage) Values() []Cluster

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

type ClusterProperties

type ClusterProperties struct {
	// Created - READ-ONLY; The UTC time when the Event Hubs Cluster was created.
	Created *string `json:"created,omitempty"`
	// Updated - READ-ONLY; The UTC time when the Event Hubs Cluster was last updated.
	Updated *string `json:"updated,omitempty"`
	// MetricID - READ-ONLY; The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
	MetricID *string `json:"metricId,omitempty"`
	// Status - READ-ONLY; Status of the Cluster resource
	Status *string `json:"status,omitempty"`
}

ClusterProperties event Hubs Cluster properties supplied in responses in List or Get operations.

type ClusterQuotaConfigurationProperties

type ClusterQuotaConfigurationProperties struct {
	autorest.Response `json:"-"`
	// Settings - All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster.
	Settings map[string]*string `json:"settings"`
}

ClusterQuotaConfigurationProperties contains all settings for the cluster.

func (ClusterQuotaConfigurationProperties) MarshalJSON

func (cqcp ClusterQuotaConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ClusterQuotaConfigurationProperties.

type ClusterSku

type ClusterSku struct {
	// Name - Name of this SKU.
	Name *string `json:"name,omitempty"`
	// Capacity - The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
	Capacity *int32 `json:"capacity,omitempty"`
}

ClusterSku SKU parameters particular to a cluster instance.

type ClustersClient

type ClustersClient struct {
	BaseClient
}

ClustersClient is the azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.

func NewClustersClient

func NewClustersClient(subscriptionID string) ClustersClient

NewClustersClient creates an instance of the ClustersClient client.

func NewClustersClientWithBaseURI

func NewClustersClientWithBaseURI(baseURI string, subscriptionID string) ClustersClient

NewClustersClientWithBaseURI creates an instance of the ClustersClient 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 (ClustersClient) Delete

func (client ClustersClient) Delete(ctx context.Context, resourceGroupName string, clusterName string) (result ClustersDeleteFuture, err error)

Delete deletes an existing Event Hubs Cluster. This operation is idempotent. Parameters: resourceGroupName - name of the resource group within the Azure subscription. clusterName - the name of the Event Hubs Cluster.

func (ClustersClient) DeletePreparer

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

DeletePreparer prepares the Delete request.

func (ClustersClient) DeleteResponder

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

func (client ClustersClient) DeleteSender(req *http.Request) (future ClustersDeleteFuture, err error)

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

func (ClustersClient) Get

func (client ClustersClient) Get(ctx context.Context, resourceGroupName string, clusterName string) (result Cluster, err error)

Get gets the resource description of the specified Event Hubs Cluster. Parameters: resourceGroupName - name of the resource group within the Azure subscription. clusterName - the name of the Event Hubs Cluster.

func (ClustersClient) GetPreparer

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

GetPreparer prepares the Get request.

func (ClustersClient) GetResponder

func (client ClustersClient) GetResponder(resp *http.Response) (result Cluster, err error)

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

func (ClustersClient) GetSender

func (client ClustersClient) 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 (ClustersClient) ListAvailableClusters

func (client ClustersClient) ListAvailableClusters(ctx context.Context) (result AvailableClustersList, err error)

ListAvailableClusters list the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.

func (ClustersClient) ListAvailableClustersPreparer

func (client ClustersClient) ListAvailableClustersPreparer(ctx context.Context) (*http.Request, error)

ListAvailableClustersPreparer prepares the ListAvailableClusters request.

func (ClustersClient) ListAvailableClustersResponder

func (client ClustersClient) ListAvailableClustersResponder(resp *http.Response) (result AvailableClustersList, err error)

ListAvailableClustersResponder handles the response to the ListAvailableClusters request. The method always closes the http.Response Body.

func (ClustersClient) ListAvailableClustersSender

func (client ClustersClient) ListAvailableClustersSender(req *http.Request) (*http.Response, error)

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

func (ClustersClient) ListByResourceGroup

func (client ClustersClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ClusterListResultPage, err error)

ListByResourceGroup lists the available Event Hubs Clusters within an ARM resource group. Parameters: resourceGroupName - name of the resource group within the Azure subscription.

func (ClustersClient) ListByResourceGroupComplete

func (client ClustersClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ClusterListResultIterator, err error)

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

func (ClustersClient) ListByResourceGroupPreparer

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ClustersClient) ListByResourceGroupResponder

func (client ClustersClient) ListByResourceGroupResponder(resp *http.Response) (result ClusterListResult, err error)

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

func (ClustersClient) ListByResourceGroupSender

func (client ClustersClient) 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 (ClustersClient) ListNamespaces

func (client ClustersClient) ListNamespaces(ctx context.Context, resourceGroupName string, clusterName string) (result EHNamespaceIDListResult, err error)

ListNamespaces list all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster. Parameters: resourceGroupName - name of the resource group within the Azure subscription. clusterName - the name of the Event Hubs Cluster.

func (ClustersClient) ListNamespacesPreparer

func (client ClustersClient) ListNamespacesPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

ListNamespacesPreparer prepares the ListNamespaces request.

func (ClustersClient) ListNamespacesResponder

func (client ClustersClient) ListNamespacesResponder(resp *http.Response) (result EHNamespaceIDListResult, err error)

ListNamespacesResponder handles the response to the ListNamespaces request. The method always closes the http.Response Body.

func (ClustersClient) ListNamespacesSender

func (client ClustersClient) ListNamespacesSender(req *http.Request) (*http.Response, error)

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

func (ClustersClient) Patch

func (client ClustersClient) Patch(ctx context.Context, resourceGroupName string, clusterName string, parameters Cluster) (result ClustersPatchFuture, err error)

Patch modifies mutable properties on the Event Hubs Cluster. This operation is idempotent. Parameters: resourceGroupName - name of the resource group within the Azure subscription. clusterName - the name of the Event Hubs Cluster. parameters - the properties of the Event Hubs Cluster which should be updated.

func (ClustersClient) PatchPreparer

func (client ClustersClient) PatchPreparer(ctx context.Context, resourceGroupName string, clusterName string, parameters Cluster) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (ClustersClient) PatchResponder

func (client ClustersClient) PatchResponder(resp *http.Response) (result Cluster, err error)

PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.

func (ClustersClient) PatchSender

func (client ClustersClient) PatchSender(req *http.Request) (future ClustersPatchFuture, err error)

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

func (ClustersClient) Put

func (client ClustersClient) Put(ctx context.Context, resourceGroupName string, clusterName string) (result ClustersPutFuture, err error)

Put creates or updates an instance of an Event Hubs Cluster. Parameters: resourceGroupName - name of the resource group within the Azure subscription. clusterName - the name of the Event Hubs Cluster.

func (ClustersClient) PutPreparer

func (client ClustersClient) PutPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

PutPreparer prepares the Put request.

func (ClustersClient) PutResponder

func (client ClustersClient) PutResponder(resp *http.Response) (result Cluster, err error)

PutResponder handles the response to the Put request. The method always closes the http.Response Body.

func (ClustersClient) PutSender

func (client ClustersClient) PutSender(req *http.Request) (future ClustersPutFuture, err error)

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

type ClustersDeleteFuture

type ClustersDeleteFuture struct {
	azure.Future
}

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

func (*ClustersDeleteFuture) Result

func (future *ClustersDeleteFuture) Result(client ClustersClient) (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 ClustersPatchFuture

type ClustersPatchFuture struct {
	azure.Future
}

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

func (*ClustersPatchFuture) Result

func (future *ClustersPatchFuture) Result(client ClustersClient) (c Cluster, err error)

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

type ClustersPutFuture

type ClustersPutFuture struct {
	azure.Future
}

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

func (*ClustersPutFuture) Result

func (future *ClustersPutFuture) Result(client ClustersClient) (c Cluster, err error)

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

type ConfigurationClient

type ConfigurationClient struct {
	BaseClient
}

ConfigurationClient is the azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.

func NewConfigurationClient

func NewConfigurationClient(subscriptionID string) ConfigurationClient

NewConfigurationClient creates an instance of the ConfigurationClient client.

func NewConfigurationClientWithBaseURI

func NewConfigurationClientWithBaseURI(baseURI string, subscriptionID string) ConfigurationClient

NewConfigurationClientWithBaseURI creates an instance of the ConfigurationClient 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 (ConfigurationClient) Get

func (client ConfigurationClient) Get(ctx context.Context, resourceGroupName string, clusterName string) (result ClusterQuotaConfigurationProperties, err error)

Get get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster. Parameters: resourceGroupName - name of the resource group within the Azure subscription. clusterName - the name of the Event Hubs Cluster.

func (ConfigurationClient) GetPreparer

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

GetPreparer prepares the Get request.

func (ConfigurationClient) GetResponder

func (client ConfigurationClient) GetResponder(resp *http.Response) (result ClusterQuotaConfigurationProperties, err error)

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

func (ConfigurationClient) GetSender

func (client ConfigurationClient) 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 (ConfigurationClient) Patch

func (client ConfigurationClient) Patch(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterQuotaConfigurationProperties) (result ClusterQuotaConfigurationProperties, err error)

Patch replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified. Parameters: resourceGroupName - name of the resource group within the Azure subscription. clusterName - the name of the Event Hubs Cluster. parameters - parameters for creating an Event Hubs Cluster resource.

func (ConfigurationClient) PatchPreparer

func (client ConfigurationClient) PatchPreparer(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterQuotaConfigurationProperties) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (ConfigurationClient) PatchResponder

func (client ConfigurationClient) PatchResponder(resp *http.Response) (result ClusterQuotaConfigurationProperties, err error)

PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.

func (ConfigurationClient) PatchSender

func (client ConfigurationClient) PatchSender(req *http.Request) (*http.Response, error)

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

type DefaultAction

type DefaultAction string

DefaultAction enumerates the values for default action.

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

func PossibleDefaultActionValues

func PossibleDefaultActionValues() []DefaultAction

PossibleDefaultActionValues returns an array of possible values for the DefaultAction const type.

type EHNamespace

type EHNamespace struct {
	autorest.Response `json:"-"`
	// Sku - Properties of sku resource
	Sku *Sku `json:"sku,omitempty"`
	// EHNamespaceProperties - Namespace properties supplied for create namespace operation.
	*EHNamespaceProperties `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"`
}

EHNamespace single Namespace item in List or Get Operation

func (EHNamespace) MarshalJSON

func (en EHNamespace) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EHNamespace.

func (*EHNamespace) UnmarshalJSON

func (en *EHNamespace) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EHNamespace struct.

type EHNamespaceIDContainer

type EHNamespaceIDContainer struct {
	// ID - id parameter
	ID *string `json:"id,omitempty"`
}

EHNamespaceIDContainer the full ARM ID of an Event Hubs Namespace

type EHNamespaceIDListResult

type EHNamespaceIDListResult struct {
	autorest.Response `json:"-"`
	// Value - Result of the List Namespace IDs operation
	Value *[]EHNamespaceIDContainer `json:"value,omitempty"`
}

EHNamespaceIDListResult the response of the List Namespace IDs operation

type EHNamespaceListResult

type EHNamespaceListResult struct {
	autorest.Response `json:"-"`
	// Value - Result of the List Namespace operation
	Value *[]EHNamespace `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"`
}

EHNamespaceListResult the response of the List Namespace operation

func (EHNamespaceListResult) IsEmpty

func (enlr EHNamespaceListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type EHNamespaceListResultIterator

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

EHNamespaceListResultIterator provides access to a complete listing of EHNamespace values.

func NewEHNamespaceListResultIterator

func NewEHNamespaceListResultIterator(page EHNamespaceListResultPage) EHNamespaceListResultIterator

Creates a new instance of the EHNamespaceListResultIterator type.

func (*EHNamespaceListResultIterator) Next

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

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

func (iter EHNamespaceListResultIterator) NotDone() bool

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

func (EHNamespaceListResultIterator) Response

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

func (EHNamespaceListResultIterator) Value

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

type EHNamespaceListResultPage

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

EHNamespaceListResultPage contains a page of EHNamespace values.

func NewEHNamespaceListResultPage

func NewEHNamespaceListResultPage(getNextPage func(context.Context, EHNamespaceListResult) (EHNamespaceListResult, error)) EHNamespaceListResultPage

Creates a new instance of the EHNamespaceListResultPage type.

func (*EHNamespaceListResultPage) Next

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

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

func (page EHNamespaceListResultPage) NotDone() bool

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

func (EHNamespaceListResultPage) Response

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

func (EHNamespaceListResultPage) Values

func (page EHNamespaceListResultPage) Values() []EHNamespace

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

type EHNamespaceProperties

type EHNamespaceProperties struct {
	// ProvisioningState - READ-ONLY; Provisioning state of the Namespace.
	ProvisioningState *string `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"`
	// ClusterArmID - Cluster ARM ID of the Namespace.
	ClusterArmID *string `json:"clusterArmId,omitempty"`
	// MetricID - READ-ONLY; Identifier for Azure Insights metrics.
	MetricID *string `json:"metricId,omitempty"`
	// IsAutoInflateEnabled - Value that indicates whether AutoInflate is enabled for eventhub namespace.
	IsAutoInflateEnabled *bool `json:"isAutoInflateEnabled,omitempty"`
	// MaximumThroughputUnits - Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)
	MaximumThroughputUnits *int32 `json:"maximumThroughputUnits,omitempty"`
	// KafkaEnabled - Value that indicates whether Kafka is enabled for eventhub namespace.
	KafkaEnabled *bool `json:"kafkaEnabled,omitempty"`
	// ZoneRedundant - Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.
	ZoneRedundant *bool `json:"zoneRedundant,omitempty"`
	// Identity - Properties of BYOK Identity description
	Identity *Identity `json:"identity,omitempty"`
	// Encryption - Properties of BYOK Encryption description
	Encryption *Encryption `json:"encryption,omitempty"`
}

EHNamespaceProperties namespace properties supplied for create namespace operation.

type Encryption

type Encryption struct {
	// KeyVaultProperties - Properties of KeyVault
	KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`
	// KeySource - Enumerates the possible value of keySource for Encryption. Possible values include: 'MicrosoftKeyVault'
	KeySource KeySource `json:"keySource,omitempty"`
}

Encryption properties to configure Encryption

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 response that indicates the service is not able to process the incoming request. The reason is provided in the error message.

type IPAction

type IPAction string

IPAction enumerates the values for ip action.

const (
	// Accept ...
	Accept IPAction = "Accept"
	// Reject ...
	Reject IPAction = "Reject"
)

func PossibleIPActionValues

func PossibleIPActionValues() []IPAction

PossibleIPActionValues returns an array of possible values for the IPAction const type.

type IPFilterRule

type IPFilterRule struct {
	autorest.Response `json:"-"`
	// IPFilterRuleProperties - Properties supplied to create or update IpFilterRules
	*IPFilterRuleProperties `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"`
}

IPFilterRule single item in a List or Get IpFilterRules operation

func (IPFilterRule) MarshalJSON

func (ifr IPFilterRule) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IPFilterRule.

func (*IPFilterRule) UnmarshalJSON

func (ifr *IPFilterRule) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for IPFilterRule struct.

type IPFilterRuleListResult

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

IPFilterRuleListResult the response from the List namespace operation.

func (IPFilterRuleListResult) IsEmpty

func (ifrlr IPFilterRuleListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type IPFilterRuleListResultIterator

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

IPFilterRuleListResultIterator provides access to a complete listing of IPFilterRule values.

func NewIPFilterRuleListResultIterator

func NewIPFilterRuleListResultIterator(page IPFilterRuleListResultPage) IPFilterRuleListResultIterator

Creates a new instance of the IPFilterRuleListResultIterator type.

func (*IPFilterRuleListResultIterator) Next

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 (*IPFilterRuleListResultIterator) NextWithContext

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

func (iter IPFilterRuleListResultIterator) NotDone() bool

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

func (IPFilterRuleListResultIterator) Response

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

func (IPFilterRuleListResultIterator) Value

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

type IPFilterRuleListResultPage

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

IPFilterRuleListResultPage contains a page of IPFilterRule values.

func NewIPFilterRuleListResultPage

func NewIPFilterRuleListResultPage(getNextPage func(context.Context, IPFilterRuleListResult) (IPFilterRuleListResult, error)) IPFilterRuleListResultPage

Creates a new instance of the IPFilterRuleListResultPage type.

func (*IPFilterRuleListResultPage) Next

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

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

func (page IPFilterRuleListResultPage) NotDone() bool

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

func (IPFilterRuleListResultPage) Response

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

func (IPFilterRuleListResultPage) Values

func (page IPFilterRuleListResultPage) Values() []IPFilterRule

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

type IPFilterRuleProperties

type IPFilterRuleProperties struct {
	// IPMask - IP Mask
	IPMask *string `json:"ipMask,omitempty"`
	// Action - The IP Filter Action. Possible values include: 'Accept', 'Reject'
	Action IPAction `json:"action,omitempty"`
	// FilterName - IP Filter name
	FilterName *string `json:"filterName,omitempty"`
}

IPFilterRuleProperties properties supplied to create or update IpFilterRules

type Identity

type Identity struct {
	// PrincipalID - ObjectId from the KeyVault
	PrincipalID *string `json:"principalId,omitempty"`
	// TenantID - TenantId from the KeyVault
	TenantID *string `json:"tenantId,omitempty"`
	// Type - Enumerates the possible value Identity type, which currently supports only 'SystemAssigned'. Possible values include: 'SystemAssigned'
	Type IdentityType `json:"type,omitempty"`
}

Identity properties to configure Identity for Bring your Own Keys

type IdentityType

type IdentityType string

IdentityType enumerates the values for identity type.

const (
	// SystemAssigned ...
	SystemAssigned IdentityType = "SystemAssigned"
)

func PossibleIdentityTypeValues

func PossibleIdentityTypeValues() []IdentityType

PossibleIdentityTypeValues returns an array of possible values for the IdentityType const type.

type KeySource

type KeySource string

KeySource enumerates the values for key source.

const (
	// MicrosoftKeyVault ...
	MicrosoftKeyVault KeySource = "Microsoft.KeyVault"
)

func PossibleKeySourceValues

func PossibleKeySourceValues() []KeySource

PossibleKeySourceValues returns an array of possible values for the KeySource const type.

type KeyVaultProperties

type KeyVaultProperties struct {
	// KeyName - Name of the Key from KeyVault
	KeyName *string `json:"keyName,omitempty"`
	// KeyVaultURI - Uri of KeyVault
	KeyVaultURI *string `json:"keyVaultUri,omitempty"`
}

KeyVaultProperties properties to configure keyVault Properties

type NWRuleSetIPRules

type NWRuleSetIPRules struct {
	// IPMask - IP Mask
	IPMask *string `json:"ipMask,omitempty"`
	// Action - The IP Filter Action. Possible values include: 'NetworkRuleIPActionAllow'
	Action NetworkRuleIPAction `json:"action,omitempty"`
}

NWRuleSetIPRules the response from the List namespace operation.

type NWRuleSetVirtualNetworkRules

type NWRuleSetVirtualNetworkRules struct {
	// Subnet - Subnet properties
	Subnet *Subnet `json:"subnet,omitempty"`
	// IgnoreMissingVnetServiceEndpoint - Value that indicates whether to ignore missing Vnet Service Endpoint
	IgnoreMissingVnetServiceEndpoint *bool `json:"ignoreMissingVnetServiceEndpoint,omitempty"`
}

NWRuleSetVirtualNetworkRules the response from the List namespace operation.

type NamespacesClient

type NamespacesClient struct {
	BaseClient
}

NamespacesClient is the azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.

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

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

CreateOrUpdate 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 creating a namespace resource.

func (NamespacesClient) CreateOrUpdateIPFilterRule

func (client NamespacesClient) CreateOrUpdateIPFilterRule(ctx context.Context, resourceGroupName string, namespaceName string, IPFilterRuleName string, parameters IPFilterRule) (result IPFilterRule, err error)

CreateOrUpdateIPFilterRule creates or updates an IpFilterRule for a Namespace. Parameters: resourceGroupName - name of the resource group within the Azure subscription. namespaceName - the Namespace name IPFilterRuleName - the IP Filter Rule name. parameters - the Namespace IpFilterRule.

func (NamespacesClient) CreateOrUpdateIPFilterRulePreparer

func (client NamespacesClient) CreateOrUpdateIPFilterRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, IPFilterRuleName string, parameters IPFilterRule) (*http.Request, error)

CreateOrUpdateIPFilterRulePreparer prepares the CreateOrUpdateIPFilterRule request.

func (NamespacesClient) CreateOrUpdateIPFilterRuleResponder

func (client NamespacesClient) CreateOrUpdateIPFilterRuleResponder(resp *http.Response) (result IPFilterRule, err error)

CreateOrUpdateIPFilterRuleResponder handles the response to the CreateOrUpdateIPFilterRule request. The method always closes the http.Response Body.

func (NamespacesClient) CreateOrUpdateIPFilterRuleSender

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

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

func (NamespacesClient) CreateOrUpdateNetworkRuleSet

func (client NamespacesClient) CreateOrUpdateNetworkRuleSet(ctx context.Context, resourceGroupName string, namespaceName string, parameters NetworkRuleSet) (result NetworkRuleSet, err error)

CreateOrUpdateNetworkRuleSet create or update NetworkRuleSet for a Namespace. Parameters: resourceGroupName - name of the resource group within the Azure subscription. namespaceName - the Namespace name parameters - the Namespace IpFilterRule.

func (NamespacesClient) CreateOrUpdateNetworkRuleSetPreparer

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

CreateOrUpdateNetworkRuleSetPreparer prepares the CreateOrUpdateNetworkRuleSet request.

func (NamespacesClient) CreateOrUpdateNetworkRuleSetResponder

func (client NamespacesClient) CreateOrUpdateNetworkRuleSetResponder(resp *http.Response) (result NetworkRuleSet, err error)

CreateOrUpdateNetworkRuleSetResponder handles the response to the CreateOrUpdateNetworkRuleSet request. The method always closes the http.Response Body.

func (NamespacesClient) CreateOrUpdateNetworkRuleSetSender

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

CreateOrUpdateNetworkRuleSetSender sends the CreateOrUpdateNetworkRuleSet 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 EHNamespace) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (NamespacesClient) CreateOrUpdateResponder

func (client NamespacesClient) CreateOrUpdateResponder(resp *http.Response) (result EHNamespace, 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) CreateOrUpdateVirtualNetworkRule

func (client NamespacesClient) CreateOrUpdateVirtualNetworkRule(ctx context.Context, resourceGroupName string, namespaceName string, virtualNetworkRuleName string, parameters VirtualNetworkRule) (result VirtualNetworkRule, err error)

CreateOrUpdateVirtualNetworkRule creates or updates an VirtualNetworkRule for a Namespace. Parameters: resourceGroupName - name of the resource group within the Azure subscription. namespaceName - the Namespace name virtualNetworkRuleName - the Virtual Network Rule name. parameters - the Namespace VirtualNetworkRule.

func (NamespacesClient) CreateOrUpdateVirtualNetworkRulePreparer

func (client NamespacesClient) CreateOrUpdateVirtualNetworkRulePreparer(ctx context.Context, resourceGroupName string, namespaceName string, virtualNetworkRuleName string, parameters VirtualNetworkRule) (*http.Request, error)

CreateOrUpdateVirtualNetworkRulePreparer prepares the CreateOrUpdateVirtualNetworkRule request.

func (NamespacesClient) CreateOrUpdateVirtualNetworkRuleResponder

func (client NamespacesClient) CreateOrUpdateVirtualNetworkRuleResponder(resp *http.Response) (result VirtualNetworkRule, err error)

CreateOrUpdateVirtualNetworkRuleResponder handles the response to the CreateOrUpdateVirtualNetworkRule request. The method always closes the http.Response Body.

func (NamespacesClient) CreateOrUpdateVirtualNetworkRuleSender

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

CreateOrUpdateVirtualNetworkRuleSender sends the CreateOrUpdateVirtualNetworkRule 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) DeleteIPFilterRule

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

DeleteIPFilterRule deletes an IpFilterRule for a Namespace. Parameters: resourceGroupName - name of the resource group within the Azure subscription. namespaceName - the Namespace name IPFilterRuleName - the IP Filter Rule name.

func (NamespacesClient) DeleteIPFilterRulePreparer

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

DeleteIPFilterRulePreparer prepares the DeleteIPFilterRule request.

func (NamespacesClient) DeleteIPFilterRuleResponder

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

DeleteIPFilterRuleResponder handles the response to the DeleteIPFilterRule request. The method always closes the http.Response Body.

func (NamespacesClient) DeleteIPFilterRuleSender

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

DeleteIPFilterRuleSender sends the DeleteIPFilterRule 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) DeleteVirtualNetworkRule

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

DeleteVirtualNetworkRule deletes an VirtualNetworkRule for a Namespace. Parameters: resourceGroupName - name of the resource group within the Azure subscription. namespaceName - the Namespace name virtualNetworkRuleName - the Virtual Network Rule name.

func (NamespacesClient) DeleteVirtualNetworkRulePreparer

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

DeleteVirtualNetworkRulePreparer prepares the DeleteVirtualNetworkRule request.

func (NamespacesClient) DeleteVirtualNetworkRuleResponder

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

DeleteVirtualNetworkRuleResponder handles the response to the DeleteVirtualNetworkRule request. The method always closes the http.Response Body.

func (NamespacesClient) DeleteVirtualNetworkRuleSender

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

DeleteVirtualNetworkRuleSender sends the DeleteVirtualNetworkRule 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 EHNamespace, err error)

Get gets the description of the specified namespace. Parameters: resourceGroupName - name of the resource group within the Azure subscription. namespaceName - the Namespace name

func (NamespacesClient) GetIPFilterRule

func (client NamespacesClient) GetIPFilterRule(ctx context.Context, resourceGroupName string, namespaceName string, IPFilterRuleName string) (result IPFilterRule, err error)

GetIPFilterRule gets an IpFilterRule for a Namespace by rule name. Parameters: resourceGroupName - name of the resource group within the Azure subscription. namespaceName - the Namespace name IPFilterRuleName - the IP Filter Rule name.

func (NamespacesClient) GetIPFilterRulePreparer

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

GetIPFilterRulePreparer prepares the GetIPFilterRule request.

func (NamespacesClient) GetIPFilterRuleResponder

func (client NamespacesClient) GetIPFilterRuleResponder(resp *http.Response) (result IPFilterRule, err error)

GetIPFilterRuleResponder handles the response to the GetIPFilterRule request. The method always closes the http.Response Body.

func (NamespacesClient) GetIPFilterRuleSender

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

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

func (NamespacesClient) GetNetworkRuleSet

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

GetNetworkRuleSet gets NetworkRuleSet for a Namespace. Parameters: resourceGroupName - name of the resource group within the Azure subscription. namespaceName - the Namespace name

func (NamespacesClient) GetNetworkRuleSetPreparer

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

GetNetworkRuleSetPreparer prepares the GetNetworkRuleSet request.

func (NamespacesClient) GetNetworkRuleSetResponder

func (client NamespacesClient) GetNetworkRuleSetResponder(resp *http.Response) (result NetworkRuleSet, err error)

GetNetworkRuleSetResponder handles the response to the GetNetworkRuleSet request. The method always closes the http.Response Body.

func (NamespacesClient) GetNetworkRuleSetSender

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

GetNetworkRuleSetSender sends the GetNetworkRuleSet 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 EHNamespace, 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) GetVirtualNetworkRule

func (client NamespacesClient) GetVirtualNetworkRule(ctx context.Context, resourceGroupName string, namespaceName string, virtualNetworkRuleName string) (result VirtualNetworkRule, err error)

GetVirtualNetworkRule gets an VirtualNetworkRule for a Namespace by rule name. Parameters: resourceGroupName - name of the resource group within the Azure subscription. namespaceName - the Namespace name virtualNetworkRuleName - the Virtual Network Rule name.

func (NamespacesClient) GetVirtualNetworkRulePreparer

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

GetVirtualNetworkRulePreparer prepares the GetVirtualNetworkRule request.

func (NamespacesClient) GetVirtualNetworkRuleResponder

func (client NamespacesClient) GetVirtualNetworkRuleResponder(resp *http.Response) (result VirtualNetworkRule, err error)

GetVirtualNetworkRuleResponder handles the response to the GetVirtualNetworkRule request. The method always closes the http.Response Body.

func (NamespacesClient) GetVirtualNetworkRuleSender

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

GetVirtualNetworkRuleSender sends the GetVirtualNetworkRule 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 EHNamespaceListResultPage, err error)

List lists all the available Namespaces within a subscription, irrespective of the resource groups.

func (NamespacesClient) ListByResourceGroup

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

ListByResourceGroup lists the available Namespaces within a resource group. Parameters: resourceGroupName - name of the resource group within the Azure subscription.

func (NamespacesClient) ListByResourceGroupComplete

func (client NamespacesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result EHNamespaceListResultIterator, 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 EHNamespaceListResult, 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 EHNamespaceListResultIterator, err error)

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

func (NamespacesClient) ListIPFilterRules

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

ListIPFilterRules gets a list of IP Filter rules for a Namespace. Parameters: resourceGroupName - name of the resource group within the Azure subscription. namespaceName - the Namespace name

func (NamespacesClient) ListIPFilterRulesComplete

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

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

func (NamespacesClient) ListIPFilterRulesPreparer

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

ListIPFilterRulesPreparer prepares the ListIPFilterRules request.

func (NamespacesClient) ListIPFilterRulesResponder

func (client NamespacesClient) ListIPFilterRulesResponder(resp *http.Response) (result IPFilterRuleListResult, err error)

ListIPFilterRulesResponder handles the response to the ListIPFilterRules request. The method always closes the http.Response Body.

func (NamespacesClient) ListIPFilterRulesSender

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

ListIPFilterRulesSender sends the ListIPFilterRules 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 EHNamespaceListResult, 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) ListVirtualNetworkRules

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

ListVirtualNetworkRules gets a list of VirtualNetwork rules for a Namespace. Parameters: resourceGroupName - name of the resource group within the Azure subscription. namespaceName - the Namespace name

func (NamespacesClient) ListVirtualNetworkRulesComplete

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

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

func (NamespacesClient) ListVirtualNetworkRulesPreparer

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

ListVirtualNetworkRulesPreparer prepares the ListVirtualNetworkRules request.

func (NamespacesClient) ListVirtualNetworkRulesResponder

func (client NamespacesClient) ListVirtualNetworkRulesResponder(resp *http.Response) (result VirtualNetworkRuleListResult, err error)

ListVirtualNetworkRulesResponder handles the response to the ListVirtualNetworkRules request. The method always closes the http.Response Body.

func (NamespacesClient) ListVirtualNetworkRulesSender

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

ListVirtualNetworkRulesSender sends the ListVirtualNetworkRules 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 EHNamespace) (result EHNamespace, 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 EHNamespace) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (NamespacesClient) UpdateResponder

func (client NamespacesClient) UpdateResponder(resp *http.Response) (result EHNamespace, 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) (en EHNamespace, 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 NetworkRuleIPAction

type NetworkRuleIPAction string

NetworkRuleIPAction enumerates the values for network rule ip action.

const (
	// NetworkRuleIPActionAllow ...
	NetworkRuleIPActionAllow NetworkRuleIPAction = "Allow"
)

func PossibleNetworkRuleIPActionValues

func PossibleNetworkRuleIPActionValues() []NetworkRuleIPAction

PossibleNetworkRuleIPActionValues returns an array of possible values for the NetworkRuleIPAction const type.

type NetworkRuleSet

type NetworkRuleSet struct {
	autorest.Response `json:"-"`
	// NetworkRuleSetProperties - NetworkRuleSet properties
	*NetworkRuleSetProperties `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"`
}

NetworkRuleSet description of topic resource.

func (NetworkRuleSet) MarshalJSON

func (nrs NetworkRuleSet) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for NetworkRuleSet.

func (*NetworkRuleSet) UnmarshalJSON

func (nrs *NetworkRuleSet) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for NetworkRuleSet struct.

type NetworkRuleSetProperties

type NetworkRuleSetProperties struct {
	// DefaultAction - Default Action for Network Rule Set. Possible values include: 'Allow', 'Deny'
	DefaultAction DefaultAction `json:"defaultAction,omitempty"`
	// VirtualNetworkRules - List VirtualNetwork Rules
	VirtualNetworkRules *[]NWRuleSetVirtualNetworkRules `json:"virtualNetworkRules,omitempty"`
	// IPRules - List of IpRules
	IPRules *[]NWRuleSetIPRules `json:"ipRules,omitempty"`
}

NetworkRuleSetProperties networkRuleSet properties

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 Event Hub REST API operation

type OperationDisplay

type OperationDisplay struct {
	// Provider - READ-ONLY; Service provider: Microsoft.EventHub
	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 Event Hub operations supported by the Microsoft.EventHub 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 Event Hub 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

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

func (OperationListResultIterator) Value

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

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 azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.

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 of the available Event Hub 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 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 Sku

type Sku struct {
	// Name - Name of this SKU. Possible values include: 'Basic', 'Standard'
	Name SkuName `json:"name,omitempty"`
	// Tier - The billing tier of this particular SKU. Possible values include: 'SkuTierBasic', 'SkuTierStandard'
	Tier SkuTier `json:"tier,omitempty"`
	// Capacity - The Event Hubs throughput units, value should be 0 to 20 throughput units.
	Capacity *int32 `json:"capacity,omitempty"`
}

Sku SKU parameters supplied to the create namespace operation

type SkuName

type SkuName string

SkuName enumerates the values for sku name.

const (
	// Basic ...
	Basic SkuName = "Basic"
	// Standard ...
	Standard SkuName = "Standard"
)

func PossibleSkuNameValues

func PossibleSkuNameValues() []SkuName

PossibleSkuNameValues returns an array of possible values for the SkuName const type.

type SkuTier

type SkuTier string

SkuTier enumerates the values for sku tier.

const (
	// SkuTierBasic ...
	SkuTierBasic SkuTier = "Basic"
	// SkuTierStandard ...
	SkuTierStandard SkuTier = "Standard"
)

func PossibleSkuTierValues

func PossibleSkuTierValues() []SkuTier

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

type Subnet

type Subnet struct {
	// ID - Resource ID of Virtual Network Subnet
	ID *string `json:"id,omitempty"`
}

Subnet properties supplied for Subnet

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

func (TrackedResource) MarshalJSON

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

MarshalJSON is the custom marshaler for TrackedResource.

type VirtualNetworkRule

type VirtualNetworkRule struct {
	autorest.Response `json:"-"`
	// VirtualNetworkRuleProperties - Properties supplied to create or update VirtualNetworkRules
	*VirtualNetworkRuleProperties `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"`
}

VirtualNetworkRule single item in a List or Get VirtualNetworkRules operation

func (VirtualNetworkRule) MarshalJSON

func (vnr VirtualNetworkRule) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for VirtualNetworkRule.

func (*VirtualNetworkRule) UnmarshalJSON

func (vnr *VirtualNetworkRule) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for VirtualNetworkRule struct.

type VirtualNetworkRuleListResult

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

VirtualNetworkRuleListResult the response from the List namespace operation.

func (VirtualNetworkRuleListResult) IsEmpty

func (vnrlr VirtualNetworkRuleListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type VirtualNetworkRuleListResultIterator

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

VirtualNetworkRuleListResultIterator provides access to a complete listing of VirtualNetworkRule values.

func NewVirtualNetworkRuleListResultIterator

func NewVirtualNetworkRuleListResultIterator(page VirtualNetworkRuleListResultPage) VirtualNetworkRuleListResultIterator

Creates a new instance of the VirtualNetworkRuleListResultIterator type.

func (*VirtualNetworkRuleListResultIterator) Next

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 (*VirtualNetworkRuleListResultIterator) NextWithContext

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

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

func (VirtualNetworkRuleListResultIterator) Response

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

func (VirtualNetworkRuleListResultIterator) Value

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

type VirtualNetworkRuleListResultPage

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

VirtualNetworkRuleListResultPage contains a page of VirtualNetworkRule values.

func NewVirtualNetworkRuleListResultPage

Creates a new instance of the VirtualNetworkRuleListResultPage type.

func (*VirtualNetworkRuleListResultPage) Next

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 (*VirtualNetworkRuleListResultPage) NextWithContext

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

func (page VirtualNetworkRuleListResultPage) NotDone() bool

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

func (VirtualNetworkRuleListResultPage) Response

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

func (VirtualNetworkRuleListResultPage) Values

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

type VirtualNetworkRuleProperties

type VirtualNetworkRuleProperties struct {
	// VirtualNetworkSubnetID - ARM ID of Virtual Network Subnet
	VirtualNetworkSubnetID *string `json:"virtualNetworkSubnetId,omitempty"`
}

VirtualNetworkRuleProperties properties supplied to create or update VirtualNetworkRules

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL