azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/mediaservices/mgmt/2015-10-01/media Index | Files | Directories

package media

import "github.com/Azure/azure-sdk-for-go/services/mediaservices/mgmt/2015-10-01/media"

Package media implements the Azure ARM Media service API version 2015-10-01.

Media Services resource management APIs.

Index

Package Files

client.go models.go operations.go service.go version.go

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type APIEndpoint Uses

type APIEndpoint struct {
    // Endpoint - The Media Services REST endpoint.
    Endpoint *string `json:"endpoint,omitempty"`
    // MajorVersion - The version of Media Services REST API.
    MajorVersion *string `json:"majorVersion,omitempty"`
}

APIEndpoint the properties for a Media Services REST API endpoint.

type APIError Uses

type APIError struct {
    // Code - Error code.
    Code *string `json:"code,omitempty"`
    // Message - Error message.
    Message *string `json:"message,omitempty"`
}

APIError the error returned from a failed Media Services REST API call.

type BaseClient Uses

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

BaseClient is the base client for Media.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type CheckNameAvailabilityInput Uses

type CheckNameAvailabilityInput struct {
    // Name - The name of the resource. A name must be globally unique.
    Name *string `json:"name,omitempty"`
    // Type - The type of the resource - mediaservices.
    Type *string `json:"type,omitempty"`
}

CheckNameAvailabilityInput the request body for CheckNameAvailability API.

type CheckNameAvailabilityOutput Uses

type CheckNameAvailabilityOutput struct {
    autorest.Response `json:"-"`
    // NameAvailable - Specifies if the name is available.
    NameAvailable *bool `json:"nameAvailable,omitempty"`
    // Reason - Specifies the reason if the name is not available. Possible values include: 'None', 'Invalid', 'AlreadyExists'
    Reason EntityNameUnavailabilityReason `json:"reason,omitempty"`
    // Message - Specifies the detailed reason if the name is not available.
    Message *string `json:"message,omitempty"`
}

CheckNameAvailabilityOutput the response body for CheckNameAvailability API.

type EntityNameUnavailabilityReason Uses

type EntityNameUnavailabilityReason string

EntityNameUnavailabilityReason enumerates the values for entity name unavailability reason.

const (
    // AlreadyExists ...
    AlreadyExists EntityNameUnavailabilityReason = "AlreadyExists"
    // Invalid ...
    Invalid EntityNameUnavailabilityReason = "Invalid"
    // None ...
    None EntityNameUnavailabilityReason = "None"
)

func PossibleEntityNameUnavailabilityReasonValues Uses

func PossibleEntityNameUnavailabilityReasonValues() []EntityNameUnavailabilityReason

PossibleEntityNameUnavailabilityReasonValues returns an array of possible values for the EntityNameUnavailabilityReason const type.

type KeyType Uses

type KeyType string

KeyType enumerates the values for key type.

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

func PossibleKeyTypeValues Uses

func PossibleKeyTypeValues() []KeyType

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

type Operation Uses

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 Media Services REST API operation

type OperationDisplay Uses

type OperationDisplay struct {
    // Provider - READ-ONLY; Service provider: Microsoft.Media
    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 Uses

type OperationListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; List of Media Services operations supported by the Microsoft.Media 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 Media Services operations.

type OperationsClient Uses

type OperationsClient struct {
    BaseClient
}

OperationsClient is the media Services resource management APIs.

func NewOperationsClient Uses

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List Uses

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

List lists all of the available Media Services REST API operations.

func (OperationsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

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 Uses

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 RegenerateKeyInput Uses

type RegenerateKeyInput struct {
    // KeyType - The keyType indicating which key you want to regenerate, Primary or Secondary. Possible values include: 'Primary', 'Secondary'
    KeyType KeyType `json:"keyType,omitempty"`
}

RegenerateKeyInput the request body for a RegenerateKey API.

type RegenerateKeyOutput Uses

type RegenerateKeyOutput struct {
    autorest.Response `json:"-"`
    // Key - The new value of either the primary or secondary key.
    Key *string `json:"key,omitempty"`
}

RegenerateKeyOutput the response body for a RegenerateKey API.

type Resource Uses

type Resource struct {
    // ID - READ-ONLY; The id of the resource.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource
    Type *string `json:"type,omitempty"`
    // Location - The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth).
    Location *string `json:"location,omitempty"`
    // Tags - Tags to help categorize the resource in the Azure portal.
    Tags map[string]*string `json:"tags"`
}

Resource the Azure Resource Manager resource.

func (Resource) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Resource.

type ResourceType Uses

type ResourceType string

ResourceType enumerates the values for resource type.

const (
    // Mediaservices ...
    Mediaservices ResourceType = "mediaservices"
)

func PossibleResourceTypeValues Uses

func PossibleResourceTypeValues() []ResourceType

PossibleResourceTypeValues returns an array of possible values for the ResourceType const type.

type Service Uses

type Service struct {
    autorest.Response `json:"-"`
    // ServiceProperties - The additional properties of a Media Service resource.
    *ServiceProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; The id of the resource.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource
    Type *string `json:"type,omitempty"`
    // Location - The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth).
    Location *string `json:"location,omitempty"`
    // Tags - Tags to help categorize the resource in the Azure portal.
    Tags map[string]*string `json:"tags"`
}

Service the properties of a Media Service resource.

func (Service) MarshalJSON Uses

func (s Service) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Service.

func (*Service) UnmarshalJSON Uses

func (s *Service) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Service struct.

type ServiceClient Uses

type ServiceClient struct {
    BaseClient
}

ServiceClient is the media Services resource management APIs.

func NewServiceClient Uses

func NewServiceClient(subscriptionID string) ServiceClient

NewServiceClient creates an instance of the ServiceClient client.

func NewServiceClientWithBaseURI Uses

func NewServiceClientWithBaseURI(baseURI string, subscriptionID string) ServiceClient

NewServiceClientWithBaseURI creates an instance of the ServiceClient client.

func (ServiceClient) CheckNameAvailability Uses

func (client ServiceClient) CheckNameAvailability(ctx context.Context, parameters CheckNameAvailabilityInput) (result CheckNameAvailabilityOutput, err error)

CheckNameAvailability checks whether the Media Service resource name is available. The name must be globally unique. Parameters: parameters - properties needed to check the availability of a name.

func (ServiceClient) CheckNameAvailabilityPreparer Uses

func (client ServiceClient) CheckNameAvailabilityPreparer(ctx context.Context, parameters CheckNameAvailabilityInput) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (ServiceClient) CheckNameAvailabilityResponder Uses

func (client ServiceClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityOutput, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (ServiceClient) CheckNameAvailabilitySender Uses

func (client ServiceClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

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

func (ServiceClient) Create Uses

func (client ServiceClient) Create(ctx context.Context, resourceGroupName string, mediaServiceName string, parameters Service) (result Service, err error)

Create creates a Media Service. Parameters: resourceGroupName - name of the resource group within the Azure subscription. mediaServiceName - name of the Media Service. parameters - media Service properties needed for creation.

func (ServiceClient) CreatePreparer Uses

func (client ServiceClient) CreatePreparer(ctx context.Context, resourceGroupName string, mediaServiceName string, parameters Service) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ServiceClient) CreateResponder Uses

func (client ServiceClient) CreateResponder(resp *http.Response) (result Service, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (ServiceClient) CreateSender Uses

func (client ServiceClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (ServiceClient) Delete Uses

func (client ServiceClient) Delete(ctx context.Context, resourceGroupName string, mediaServiceName string) (result autorest.Response, err error)

Delete deletes a Media Service. Parameters: resourceGroupName - name of the resource group within the Azure subscription. mediaServiceName - name of the Media Service.

func (ServiceClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (ServiceClient) DeleteResponder Uses

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

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

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

func (ServiceClient) Get Uses

func (client ServiceClient) Get(ctx context.Context, resourceGroupName string, mediaServiceName string) (result Service, err error)

Get gets a Media Service. Parameters: resourceGroupName - name of the resource group within the Azure subscription. mediaServiceName - name of the Media Service.

func (ServiceClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (ServiceClient) GetResponder Uses

func (client ServiceClient) GetResponder(resp *http.Response) (result Service, err error)

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

func (ServiceClient) GetSender Uses

func (client ServiceClient) 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 (ServiceClient) ListByResourceGroup Uses

func (client ServiceClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ServiceCollection, err error)

ListByResourceGroup lists all of the Media Services in a resource group. Parameters: resourceGroupName - name of the resource group within the Azure subscription.

func (ServiceClient) ListByResourceGroupPreparer Uses

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ServiceClient) ListByResourceGroupResponder Uses

func (client ServiceClient) ListByResourceGroupResponder(resp *http.Response) (result ServiceCollection, err error)

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

func (ServiceClient) ListByResourceGroupSender Uses

func (client ServiceClient) 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 (ServiceClient) ListKeys Uses

func (client ServiceClient) ListKeys(ctx context.Context, resourceGroupName string, mediaServiceName string) (result ServiceKeys, err error)

ListKeys lists the keys for a Media Service. Parameters: resourceGroupName - name of the resource group within the Azure subscription. mediaServiceName - name of the Media Service.

func (ServiceClient) ListKeysPreparer Uses

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

ListKeysPreparer prepares the ListKeys request.

func (ServiceClient) ListKeysResponder Uses

func (client ServiceClient) ListKeysResponder(resp *http.Response) (result ServiceKeys, err error)

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

func (ServiceClient) ListKeysSender Uses

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

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

func (ServiceClient) RegenerateKey Uses

func (client ServiceClient) RegenerateKey(ctx context.Context, resourceGroupName string, mediaServiceName string, parameters RegenerateKeyInput) (result RegenerateKeyOutput, err error)

RegenerateKey regenerates a primary or secondary key for a Media Service. Parameters: resourceGroupName - name of the resource group within the Azure subscription. mediaServiceName - name of the Media Service. parameters - properties needed to regenerate the Media Service key.

func (ServiceClient) RegenerateKeyPreparer Uses

func (client ServiceClient) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, mediaServiceName string, parameters RegenerateKeyInput) (*http.Request, error)

RegenerateKeyPreparer prepares the RegenerateKey request.

func (ServiceClient) RegenerateKeyResponder Uses

func (client ServiceClient) RegenerateKeyResponder(resp *http.Response) (result RegenerateKeyOutput, err error)

RegenerateKeyResponder handles the response to the RegenerateKey request. The method always closes the http.Response Body.

func (ServiceClient) RegenerateKeySender Uses

func (client ServiceClient) RegenerateKeySender(req *http.Request) (*http.Response, error)

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

func (ServiceClient) SyncStorageKeys Uses

func (client ServiceClient) SyncStorageKeys(ctx context.Context, resourceGroupName string, mediaServiceName string, parameters SyncStorageKeysInput) (result autorest.Response, err error)

SyncStorageKeys synchronizes storage account keys for a storage account associated with the Media Service account. Parameters: resourceGroupName - name of the resource group within the Azure subscription. mediaServiceName - name of the Media Service. parameters - properties needed to synchronize the keys for a storage account to the Media Service.

func (ServiceClient) SyncStorageKeysPreparer Uses

func (client ServiceClient) SyncStorageKeysPreparer(ctx context.Context, resourceGroupName string, mediaServiceName string, parameters SyncStorageKeysInput) (*http.Request, error)

SyncStorageKeysPreparer prepares the SyncStorageKeys request.

func (ServiceClient) SyncStorageKeysResponder Uses

func (client ServiceClient) SyncStorageKeysResponder(resp *http.Response) (result autorest.Response, err error)

SyncStorageKeysResponder handles the response to the SyncStorageKeys request. The method always closes the http.Response Body.

func (ServiceClient) SyncStorageKeysSender Uses

func (client ServiceClient) SyncStorageKeysSender(req *http.Request) (*http.Response, error)

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

func (ServiceClient) Update Uses

func (client ServiceClient) Update(ctx context.Context, resourceGroupName string, mediaServiceName string, parameters Service) (result Service, err error)

Update updates a Media Service. Parameters: resourceGroupName - name of the resource group within the Azure subscription. mediaServiceName - name of the Media Service. parameters - media Service properties needed for update.

func (ServiceClient) UpdatePreparer Uses

func (client ServiceClient) UpdatePreparer(ctx context.Context, resourceGroupName string, mediaServiceName string, parameters Service) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ServiceClient) UpdateResponder Uses

func (client ServiceClient) UpdateResponder(resp *http.Response) (result Service, err error)

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

func (ServiceClient) UpdateSender Uses

func (client ServiceClient) 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 ServiceCollection Uses

type ServiceCollection struct {
    autorest.Response `json:"-"`
    // Value - The collection of Media Service resources.
    Value *[]Service `json:"value,omitempty"`
}

ServiceCollection the collection of Media Service resources.

type ServiceKeys Uses

type ServiceKeys struct {
    autorest.Response `json:"-"`
    // PrimaryAuthEndpoint - The primary authorization endpoint.
    PrimaryAuthEndpoint *string `json:"primaryAuthEndpoint,omitempty"`
    // SecondaryAuthEndpoint - The secondary authorization endpoint.
    SecondaryAuthEndpoint *string `json:"secondaryAuthEndpoint,omitempty"`
    // PrimaryKey - The primary key for the Media Service resource.
    PrimaryKey *string `json:"primaryKey,omitempty"`
    // SecondaryKey - The secondary key for the Media Service resource.
    SecondaryKey *string `json:"secondaryKey,omitempty"`
    // Scope - The authorization scope.
    Scope *string `json:"scope,omitempty"`
}

ServiceKeys the response body for a ListKeys API.

type ServiceProperties Uses

type ServiceProperties struct {
    // APIEndpoints - READ-ONLY; Read-only property that lists the Media Services REST API endpoints for this resource. If supplied on a PUT or PATCH, the value will be ignored.
    APIEndpoints *[]APIEndpoint `json:"apiEndpoints,omitempty"`
    // StorageAccounts - The storage accounts for this resource.
    StorageAccounts *[]StorageAccount `json:"storageAccounts,omitempty"`
}

ServiceProperties the additional properties of a Media Service resource.

type StorageAccount Uses

type StorageAccount struct {
    // ID - The id of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts (isPrimary false).
    ID  *string `json:"id,omitempty"`
    // IsPrimary - Is this storage account resource the primary storage account for the Media Service resource. Blob only storage must set this to false.
    IsPrimary *bool `json:"isPrimary,omitempty"`
}

StorageAccount the properties of a storage account associated with this resource.

type SyncStorageKeysInput Uses

type SyncStorageKeysInput struct {
    // ID - The id of the storage account resource.
    ID *string `json:"id,omitempty"`
}

SyncStorageKeysInput the request body for a SyncStorageKeys API.

Directories

PathSynopsis
mediaapi

Package media imports 8 packages (graph) and is imported by 4 packages. Updated 2019-08-27. Refresh now. Tools for package owners.