streamingendpoints

package
v0.0.0-...-a81a29a Latest Latest
Warning

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

 Go to latest Published: Jun 15, 2023 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/media/2021-11-01/streamingendpoints Documentation

The streamingendpoints SDK allows for interaction with the Azure Resource Manager Service media (API Version 2021-11-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/media/2021-11-01/streamingendpoints"

Client Initialization

client := streamingendpoints.NewStreamingEndpointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: StreamingEndpointsClient.Create

ctx := context.TODO()
id := streamingendpoints.NewStreamingEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue", "streamingEndpointValue")

payload := streamingendpoints.StreamingEndpoint{
	// ...
}


if err := client.CreateThenPoll(ctx, id, payload, streamingendpoints.DefaultCreateOperationOptions()); err != nil {
	// handle the error
}

Example Usage: StreamingEndpointsClient.Delete

ctx := context.TODO()
id := streamingendpoints.NewStreamingEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue", "streamingEndpointValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: StreamingEndpointsClient.Get

ctx := context.TODO()
id := streamingendpoints.NewStreamingEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue", "streamingEndpointValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: StreamingEndpointsClient.List

ctx := context.TODO()
id := streamingendpoints.NewMediaServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue")

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: StreamingEndpointsClient.Scale

ctx := context.TODO()
id := streamingendpoints.NewStreamingEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue", "streamingEndpointValue")

payload := streamingendpoints.StreamingEntityScaleUnit{
	// ...
}


if err := client.ScaleThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: StreamingEndpointsClient.Skus

ctx := context.TODO()
id := streamingendpoints.NewStreamingEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue", "streamingEndpointValue")

read, err := client.Skus(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: StreamingEndpointsClient.Start

ctx := context.TODO()
id := streamingendpoints.NewStreamingEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue", "streamingEndpointValue")

if err := client.StartThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: StreamingEndpointsClient.Stop

ctx := context.TODO()
id := streamingendpoints.NewStreamingEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue", "streamingEndpointValue")

if err := client.StopThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: StreamingEndpointsClient.Update

ctx := context.TODO()
id := streamingendpoints.NewStreamingEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue", "streamingEndpointValue")

payload := streamingendpoints.StreamingEndpoint{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForStreamingEndpointResourceState 

func PossibleValuesForStreamingEndpointResourceState() []string

func ValidateMediaServiceID 

func ValidateMediaServiceID(input interface{}, key string) (warnings []string, errors []error)

ValidateMediaServiceID checks that 'input' can be parsed as a Media Service ID

func ValidateStreamingEndpointID 

func ValidateStreamingEndpointID(input interface{}, key string) (warnings []string, errors []error)

ValidateStreamingEndpointID checks that 'input' can be parsed as a Streaming Endpoint ID

Types

type AkamaiAccessControl 

type AkamaiAccessControl struct {
	AkamaiSignatureHeaderAuthenticationKeyList *[]AkamaiSignatureHeaderAuthenticationKey `json:"akamaiSignatureHeaderAuthenticationKeyList,omitempty"`
}

type AkamaiSignatureHeaderAuthenticationKey 

type AkamaiSignatureHeaderAuthenticationKey struct {
	Base64Key  *string `json:"base64Key,omitempty"`
	Expiration *string `json:"expiration,omitempty"`
	Identifier *string `json:"identifier,omitempty"`
}

func (*AkamaiSignatureHeaderAuthenticationKey) GetExpirationAsTime 

func (o *AkamaiSignatureHeaderAuthenticationKey) GetExpirationAsTime() (*time.Time, error)

func (*AkamaiSignatureHeaderAuthenticationKey) SetExpirationAsTime 

func (o *AkamaiSignatureHeaderAuthenticationKey) SetExpirationAsTime(input time.Time)

type ArmStreamingEndpointCapacity 

type ArmStreamingEndpointCapacity struct {
	Default   *int64  `json:"default,omitempty"`
	Maximum   *int64  `json:"maximum,omitempty"`
	Minimum   *int64  `json:"minimum,omitempty"`
	ScaleType *string `json:"scaleType,omitempty"`
}

type ArmStreamingEndpointCurrentSku 

type ArmStreamingEndpointCurrentSku struct {
	Capacity *int64  `json:"capacity,omitempty"`
	Name     *string `json:"name,omitempty"`
}

type ArmStreamingEndpointSku 

type ArmStreamingEndpointSku struct {
	Name *string `json:"name,omitempty"`
}

type ArmStreamingEndpointSkuInfo 

type ArmStreamingEndpointSkuInfo struct {
	Capacity     *ArmStreamingEndpointCapacity `json:"capacity,omitempty"`
	ResourceType *string                       `json:"resourceType,omitempty"`
	Sku          *ArmStreamingEndpointSku      `json:"sku,omitempty"`
}

type CreateOperationOptions 

type CreateOperationOptions struct {
	AutoStart *bool
}

func DefaultCreateOperationOptions 

func DefaultCreateOperationOptions() CreateOperationOptions

func (CreateOperationOptions) ToHeaders 

func (o CreateOperationOptions) ToHeaders() *client.Headers

func (CreateOperationOptions) ToOData 

func (o CreateOperationOptions) ToOData() *odata.Query

func (CreateOperationOptions) ToQuery 

func (o CreateOperationOptions) ToQuery() *client.QueryParams

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type CrossSiteAccessPolicies 

type CrossSiteAccessPolicies struct {
	ClientAccessPolicy *string `json:"clientAccessPolicy,omitempty"`
	CrossDomainPolicy  *string `json:"crossDomainPolicy,omitempty"`
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StreamingEndpoint
}

type IPAccessControl 

type IPAccessControl struct {
	Allow *[]IPRange `json:"allow,omitempty"`
}

type IPRange 

type IPRange struct {
	Address            *string `json:"address,omitempty"`
	Name               *string `json:"name,omitempty"`
	SubnetPrefixLength *int64  `json:"subnetPrefixLength,omitempty"`
}

type ListCompleteResult 

type ListCompleteResult struct {
	Items []StreamingEndpoint
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]StreamingEndpoint
}

type MediaServiceId 

type MediaServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	MediaServiceName  string
}

MediaServiceId is a struct representing the Resource ID for a Media Service

func NewMediaServiceID 

func NewMediaServiceID(subscriptionId string, resourceGroupName string, mediaServiceName string) MediaServiceId

NewMediaServiceID returns a new MediaServiceId struct

func ParseMediaServiceID 

func ParseMediaServiceID(input string) (*MediaServiceId, error)

ParseMediaServiceID parses 'input' into a MediaServiceId

func ParseMediaServiceIDInsensitively 

func ParseMediaServiceIDInsensitively(input string) (*MediaServiceId, error)

ParseMediaServiceIDInsensitively parses 'input' case-insensitively into a MediaServiceId note: this method should only be used for API response data and not user input

func (MediaServiceId) ID 

func (id MediaServiceId) ID() string

ID returns the formatted Media Service ID

func (MediaServiceId) Segments 

func (id MediaServiceId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Media Service ID

func (MediaServiceId) String 

func (id MediaServiceId) String() string

String returns a human-readable description of this Media Service ID

type ScaleOperationResponse 

type ScaleOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type SkusOperationResponse 

type SkusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StreamingEndpointSkuInfoListResult
}

type StartOperationResponse 

type StartOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type StopOperationResponse 

type StopOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type StreamingEndpoint 

type StreamingEndpoint struct {
	Id         *string                         `json:"id,omitempty"`
	Location   string                          `json:"location"`
	Name       *string                         `json:"name,omitempty"`
	Properties *StreamingEndpointProperties    `json:"properties,omitempty"`
	Sku        *ArmStreamingEndpointCurrentSku `json:"sku,omitempty"`
	SystemData *systemdata.SystemData          `json:"systemData,omitempty"`
	Tags       *map[string]string              `json:"tags,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type StreamingEndpointAccessControl 

type StreamingEndpointAccessControl struct {
	Akamai *AkamaiAccessControl `json:"akamai,omitempty"`
	IP     *IPAccessControl     `json:"ip,omitempty"`
}

type StreamingEndpointId 

type StreamingEndpointId struct {
	SubscriptionId        string
	ResourceGroupName     string
	MediaServiceName      string
	StreamingEndpointName string
}

StreamingEndpointId is a struct representing the Resource ID for a Streaming Endpoint

func NewStreamingEndpointID 

func NewStreamingEndpointID(subscriptionId string, resourceGroupName string, mediaServiceName string, streamingEndpointName string) StreamingEndpointId

NewStreamingEndpointID returns a new StreamingEndpointId struct

func ParseStreamingEndpointID 

func ParseStreamingEndpointID(input string) (*StreamingEndpointId, error)

ParseStreamingEndpointID parses 'input' into a StreamingEndpointId

func ParseStreamingEndpointIDInsensitively 

func ParseStreamingEndpointIDInsensitively(input string) (*StreamingEndpointId, error)

ParseStreamingEndpointIDInsensitively parses 'input' case-insensitively into a StreamingEndpointId note: this method should only be used for API response data and not user input

func (StreamingEndpointId) ID 

func (id StreamingEndpointId) ID() string

ID returns the formatted Streaming Endpoint ID

func (StreamingEndpointId) Segments 

func (id StreamingEndpointId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Streaming Endpoint ID

func (StreamingEndpointId) String 

func (id StreamingEndpointId) String() string

String returns a human-readable description of this Streaming Endpoint ID

type StreamingEndpointOperationPredicate 

type StreamingEndpointOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (StreamingEndpointOperationPredicate) Matches 

func (p StreamingEndpointOperationPredicate) Matches(input StreamingEndpoint) bool

type StreamingEndpointProperties 

type StreamingEndpointProperties struct {
	AccessControl           *StreamingEndpointAccessControl `json:"accessControl,omitempty"`
	AvailabilitySetName     *string                         `json:"availabilitySetName,omitempty"`
	CdnEnabled              *bool                           `json:"cdnEnabled,omitempty"`
	CdnProfile              *string                         `json:"cdnProfile,omitempty"`
	CdnProvider             *string                         `json:"cdnProvider,omitempty"`
	Created                 *string                         `json:"created,omitempty"`
	CrossSiteAccessPolicies *CrossSiteAccessPolicies        `json:"crossSiteAccessPolicies,omitempty"`
	CustomHostNames         *[]string                       `json:"customHostNames,omitempty"`
	Description             *string                         `json:"description,omitempty"`
	FreeTrialEndTime        *string                         `json:"freeTrialEndTime,omitempty"`
	HostName                *string                         `json:"hostName,omitempty"`
	LastModified            *string                         `json:"lastModified,omitempty"`
	MaxCacheAge             *int64                          `json:"maxCacheAge,omitempty"`
	ProvisioningState       *string                         `json:"provisioningState,omitempty"`
	ResourceState           *StreamingEndpointResourceState `json:"resourceState,omitempty"`
	ScaleUnits              int64                           `json:"scaleUnits"`
}

func (*StreamingEndpointProperties) GetCreatedAsTime 

func (o *StreamingEndpointProperties) GetCreatedAsTime() (*time.Time, error)

func (*StreamingEndpointProperties) GetFreeTrialEndTimeAsTime 

func (o *StreamingEndpointProperties) GetFreeTrialEndTimeAsTime() (*time.Time, error)

func (*StreamingEndpointProperties) GetLastModifiedAsTime 

func (o *StreamingEndpointProperties) GetLastModifiedAsTime() (*time.Time, error)

func (*StreamingEndpointProperties) SetCreatedAsTime 

func (o *StreamingEndpointProperties) SetCreatedAsTime(input time.Time)

func (*StreamingEndpointProperties) SetFreeTrialEndTimeAsTime 

func (o *StreamingEndpointProperties) SetFreeTrialEndTimeAsTime(input time.Time)

func (*StreamingEndpointProperties) SetLastModifiedAsTime 

func (o *StreamingEndpointProperties) SetLastModifiedAsTime(input time.Time)

type StreamingEndpointResourceState 

type StreamingEndpointResourceState string
const (
	StreamingEndpointResourceStateDeleting StreamingEndpointResourceState = "Deleting"
	StreamingEndpointResourceStateRunning  StreamingEndpointResourceState = "Running"
	StreamingEndpointResourceStateScaling  StreamingEndpointResourceState = "Scaling"
	StreamingEndpointResourceStateStarting StreamingEndpointResourceState = "Starting"
	StreamingEndpointResourceStateStopped  StreamingEndpointResourceState = "Stopped"
	StreamingEndpointResourceStateStopping StreamingEndpointResourceState = "Stopping"
)

func (*StreamingEndpointResourceState) UnmarshalJSON 

func (s *StreamingEndpointResourceState) UnmarshalJSON(bytes []byte) error

type StreamingEndpointSkuInfoListResult 

type StreamingEndpointSkuInfoListResult struct {
	Value *[]ArmStreamingEndpointSkuInfo `json:"value,omitempty"`
}

type StreamingEndpointsClient 

type StreamingEndpointsClient struct {
	Client *resourcemanager.Client
}

func NewStreamingEndpointsClientWithBaseURI 

func NewStreamingEndpointsClientWithBaseURI(api environments.Api) (*StreamingEndpointsClient, error)

func (StreamingEndpointsClient) Create 

func (c StreamingEndpointsClient) Create(ctx context.Context, id StreamingEndpointId, input StreamingEndpoint, options CreateOperationOptions) (result CreateOperationResponse, err error)

Create ...

func (StreamingEndpointsClient) CreateThenPoll 

func (c StreamingEndpointsClient) CreateThenPoll(ctx context.Context, id StreamingEndpointId, input StreamingEndpoint, options CreateOperationOptions) error

CreateThenPoll performs Create then polls until it's completed

func (StreamingEndpointsClient) Delete 

func (c StreamingEndpointsClient) Delete(ctx context.Context, id StreamingEndpointId) (result DeleteOperationResponse, err error)

Delete ...

func (StreamingEndpointsClient) DeleteThenPoll 

func (c StreamingEndpointsClient) DeleteThenPoll(ctx context.Context, id StreamingEndpointId) error

DeleteThenPoll performs Delete then polls until it's completed

func (StreamingEndpointsClient) Get 

func (c StreamingEndpointsClient) Get(ctx context.Context, id StreamingEndpointId) (result GetOperationResponse, err error)

Get ...

func (StreamingEndpointsClient) List 

func (c StreamingEndpointsClient) List(ctx context.Context, id MediaServiceId) (result ListOperationResponse, err error)

List ...

func (StreamingEndpointsClient) ListComplete 

func (c StreamingEndpointsClient) ListComplete(ctx context.Context, id MediaServiceId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (StreamingEndpointsClient) ListCompleteMatchingPredicate 

func (c StreamingEndpointsClient) ListCompleteMatchingPredicate(ctx context.Context, id MediaServiceId, predicate StreamingEndpointOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (StreamingEndpointsClient) Scale 

func (c StreamingEndpointsClient) Scale(ctx context.Context, id StreamingEndpointId, input StreamingEntityScaleUnit) (result ScaleOperationResponse, err error)

Scale ...

func (StreamingEndpointsClient) ScaleThenPoll 

func (c StreamingEndpointsClient) ScaleThenPoll(ctx context.Context, id StreamingEndpointId, input StreamingEntityScaleUnit) error

ScaleThenPoll performs Scale then polls until it's completed

func (StreamingEndpointsClient) Skus 

func (c StreamingEndpointsClient) Skus(ctx context.Context, id StreamingEndpointId) (result SkusOperationResponse, err error)

Skus ...

func (StreamingEndpointsClient) Start 

func (c StreamingEndpointsClient) Start(ctx context.Context, id StreamingEndpointId) (result StartOperationResponse, err error)

Start ...

func (StreamingEndpointsClient) StartThenPoll 

func (c StreamingEndpointsClient) StartThenPoll(ctx context.Context, id StreamingEndpointId) error

StartThenPoll performs Start then polls until it's completed

func (StreamingEndpointsClient) Stop 

func (c StreamingEndpointsClient) Stop(ctx context.Context, id StreamingEndpointId) (result StopOperationResponse, err error)

Stop ...

func (StreamingEndpointsClient) StopThenPoll 

func (c StreamingEndpointsClient) StopThenPoll(ctx context.Context, id StreamingEndpointId) error

StopThenPoll performs Stop then polls until it's completed

func (StreamingEndpointsClient) Update 

func (c StreamingEndpointsClient) Update(ctx context.Context, id StreamingEndpointId, input StreamingEndpoint) (result UpdateOperationResponse, err error)

Update ...

func (StreamingEndpointsClient) UpdateThenPoll 

func (c StreamingEndpointsClient) UpdateThenPoll(ctx context.Context, id StreamingEndpointId, input StreamingEndpoint) error

UpdateThenPoll performs Update then polls until it's completed

type StreamingEntityScaleUnit 

type StreamingEntityScaleUnit struct {
	ScaleUnit *int64 `json:"scaleUnit,omitempty"`
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

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.