swagger: '2.0'
info:
  title: Microsoft Azure MediaServicesManagementClient
  description: Media Services resource management APIs.
  version: '2015-10-01'
host: management.azure.com
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
security:
  - azure_auth:
      - user_impersonation
securityDefinitions:
  azure_auth:
    type: oauth2
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    flow: implicit
    description: Azure Active Directory OAuth2 Flow
    scopes:
      user_impersonation: impersonate your user account
paths:
  /providers/Microsoft.Media/operations:
    get:
      operationId: microsoftAzureOperationsList
      description: Lists all of the available Media Services REST API operations.
      externalDocs:
        url: https://aka.ms/media-manage
      x-ms-examples:
        OperationsList:
          $ref: ./examples/OperationsList.json
      parameters:
        - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Success. Returns a list of operations.
          schema:
            $ref: '#/definitions/OperationListResult'
      summary: Microsoft Azure Get Providers Microsoft Media Operations
      tags:
        - Providers
  /subscriptions/{subscriptionId}/providers/Microsoft.Media/CheckNameAvailability:
    post:
      operationId: microsoftAzureMediaserviceChecknameavailability
      description: >-
        Checks whether the Media Service resource name is available. The name
        must be globally unique.
      externalDocs:
        url: https://aka.ms/media-manage
      x-ms-examples:
        MediaServiceCheckNameAvailability:
          $ref: ./examples/MediaServiceCheckNameAvailability.json
      parameters:
        - $ref: '#/parameters/subscriptionIdParameter'
        - $ref: '#/parameters/apiVersionParameter'
        - name: parameters
          description: Properties needed to check the availability of a name.
          in: body
          required: true
          schema:
            $ref: '#/definitions/CheckNameAvailabilityInput'
      responses:
        '200':
          description: >-
            Success. Returns details about whether a Media Service resource name
            is available.
          schema:
            $ref: '#/definitions/CheckNameAvailabilityOutput'
          examples:
            application/json:
              nameAvailable: false
              reason: AlreadyExists
              message: >-
                Already in use by another Media Service instance. Please try
                again with a name that is not likely to be in use.
        default:
          description: CheckNameAvailability of a Media Service failed.
          schema:
            $ref: '#/definitions/ApiError'
      summary: >-
        Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Media Checknameavailability
      tags:
        - Subscriptions
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices:
    get:
      operationId: microsoftAzureMediaserviceListbyresourcegroup
      description: Lists all of the Media Services in a resource group.
      externalDocs:
        url: https://aka.ms/media-manage
      x-ms-examples:
        MediaServiceListByResourceGroup:
          $ref: ./examples/MediaServiceListByResourceGroup.json
      parameters:
        - $ref: '#/parameters/subscriptionIdParameter'
        - $ref: '#/parameters/apiVersionParameter'
        - $ref: '#/parameters/resourceGroupNameParameter'
      responses:
        '200':
          description: >-
            Success. Returns a list of all of the Media Services accounts in a
            resource group.
          schema:
            $ref: '#/definitions/MediaServiceCollection'
          examples:
            application/json:
              value:
                - name: contosomedia
                  id: >-
                    /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia
                  type: Microsoft.Media/mediaservices
                  location: West US
                  properties:
                    apiEndpoints:
                      - endpoint: https://wamsbayclus001rest-hs.cloudapp.net/api/
                        majorVersion: '2'
                    storageAccounts:
                      - id: >-
                          /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia
                        isPrimary: true
        default:
          description: List Media Services failed.
          schema:
            $ref: '#/definitions/ApiError'
      x-ms-pageable:
        nextLinkName:
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}
  : get:
      operationId: microsoftAzureMediaserviceGet
      description: Gets a Media Service.
      externalDocs:
        url: https://aka.ms/media-manage
      x-ms-examples:
        MediaServiceGet:
          $ref: ./examples/MediaServiceGet.json
      parameters:
        - $ref: '#/parameters/subscriptionIdParameter'
        - $ref: '#/parameters/apiVersionParameter'
        - $ref: '#/parameters/resourceGroupNameParameter'
        - $ref: '#/parameters/mediaResourceNameParameter'
      responses:
        '200':
          description: Success. Returns the details of the Media Services account.
          schema:
            $ref: '#/definitions/MediaService'
          examples:
            application/json:
              name: contosomedia
              id: >-
                /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia
              type: Microsoft.Media/mediaservices
              location: West US
              properties:
                apiEndpoints:
                  - endpoint: https://wamsbayclus001rest-hs.cloudapp.net/api/
                    majorVersion: '2'
                storageAccounts:
                  - id: >-
                      /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia
                    isPrimary: true
        default:
          description: Get Media Services failed.
          schema:
            $ref: '#/definitions/ApiError'
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices Mediaservicename
      tags:
        - Subscriptions
    put:
      operationId: microsoftAzureMediaserviceCreate
      description: Creates a Media Service.
      externalDocs:
        url: https://aka.ms/media-manage
      x-ms-examples:
        MediaServiceCreate:
          $ref: ./examples/MediaServiceCreate.json
      parameters:
        - $ref: '#/parameters/subscriptionIdParameter'
        - $ref: '#/parameters/apiVersionParameter'
        - $ref: '#/parameters/resourceGroupNameParameter'
        - $ref: '#/parameters/mediaResourceNameParameter'
        - name: parameters
          description: Media Service properties needed for creation.
          in: body
          required: true
          schema:
            $ref: '#/definitions/MediaService'
      responses:
        '201':
          description: Success. Returns the new Media Services account.
          schema:
            $ref: '#/definitions/MediaService'
          examples:
            application/json:
              name: contosomedia
              id: >-
                /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia
              type: Microsoft.Media/mediaservices
              location: West US
              properties:
                apiEndpoints:
                  - endpoint: https://wamsbayclus001rest-hs.cloudapp.net/api/
                    majorVersion: '2'
                storageAccounts:
                  - id: >-
                      /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia
                    isPrimary: true
        default:
          description: Create Media Services failed.
          schema:
            $ref: '#/definitions/ApiError'
      summary: >-
        Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices Mediaservicename
      tags:
        - Subscriptions
    delete:
      operationId: microsoftAzureMediaserviceDelete
      description: Deletes a Media Service.
      externalDocs:
        url: https://aka.ms/media-manage
      x-ms-examples:
        MediaServiceDelete:
          $ref: ./examples/MediaServiceDelete.json
      parameters:
        - $ref: '#/parameters/subscriptionIdParameter'
        - $ref: '#/parameters/apiVersionParameter'
        - $ref: '#/parameters/resourceGroupNameParameter'
        - $ref: '#/parameters/mediaResourceNameParameter'
      responses:
        '200':
          description: Success. The Media Services account was deleted.
        '204':
          description: No Content. The account name does not exist.
        default:
          description: Delete Media Services failed.
          schema:
            $ref: '#/definitions/ApiError'
      summary: >-
        Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices Mediaservicename
      tags:
        - Subscriptions
    patch:
      operationId: microsoftAzureMediaserviceUpdate
      description: Updates a Media Service.
      externalDocs:
        url: https://aka.ms/media-manage
      x-ms-examples:
        MediaServiceUpdate:
          $ref: ./examples/MediaServiceUpdate.json
      parameters:
        - $ref: '#/parameters/subscriptionIdParameter'
        - $ref: '#/parameters/apiVersionParameter'
        - $ref: '#/parameters/resourceGroupNameParameter'
        - $ref: '#/parameters/mediaResourceNameParameter'
        - name: parameters
          description: Media Service properties needed for update.
          in: body
          required: true
          schema:
            $ref: '#/definitions/MediaService'
      responses:
        '200':
          description: Success. The Media Services account was updated.
          schema:
            $ref: '#/definitions/MediaService'
          examples:
            application/json:
              name: contosomedia
              id: >-
                /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia
              type: Microsoft.Media/mediaservices
              location: West US
              properties:
                apiEndpoints:
                  - endpoint: https://wamsbayclus001rest-hs.cloudapp.net/api/
                    majorVersion: '2'
                storageAccounts:
                  - id: >-
                      /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia
                    isPrimary: true
        default:
          description: Update Media Services failed.
          schema:
            $ref: '#/definitions/ApiError'
      summary: >-
        Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices Mediaservicename
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/regenerateKey
  : post:
      operationId: microsoftAzureMediaserviceRegeneratekey
      description: Regenerates a primary or secondary key for a Media Service.
      externalDocs:
        url: https://aka.ms/media-manage
      x-ms-examples:
        MediaServiceRegenerateKey:
          $ref: ./examples/MediaServiceRegenerateKey.json
      parameters:
        - $ref: '#/parameters/subscriptionIdParameter'
        - $ref: '#/parameters/apiVersionParameter'
        - $ref: '#/parameters/resourceGroupNameParameter'
        - $ref: '#/parameters/mediaResourceNameParameter'
        - name: parameters
          description: Properties needed to regenerate the Media Service key.
          in: body
          required: true
          schema:
            $ref: '#/definitions/RegenerateKeyInput'
      responses:
        '200':
          description: >-
            Success. The Media Services key specified in the input was
            regenerated.
          schema:
            $ref: '#/definitions/RegenerateKeyOutput'
          examples:
            application/json:
              key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=
        default:
          description: Regenerate Media Service key failed.
          schema:
            $ref: '#/definitions/ApiError'
      summary: >-
        Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices Mediaservicename Regeneratekey
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/listKeys
  : post:
      operationId: microsoftAzureMediaserviceListkeys
      description: Lists the keys for a Media Service.
      externalDocs:
        url: https://aka.ms/media-manage
      x-ms-examples:
        MediaServiceListKeys:
          $ref: ./examples/MediaServiceListKeys.json
      parameters:
        - $ref: '#/parameters/subscriptionIdParameter'
        - $ref: '#/parameters/apiVersionParameter'
        - $ref: '#/parameters/resourceGroupNameParameter'
        - $ref: '#/parameters/mediaResourceNameParameter'
      responses:
        '200':
          description: Success. The keys for the Media Services account were listed.
          schema:
            $ref: '#/definitions/ServiceKeys'
          examples:
            application/json:
              primaryAuthEndpoint: https://wamsprodglobal001acs.accesscontrol.windows.net/
              secondaryAuthEndpoint: https://wamsprodglobal002acs.accesscontrol.windows.net/
              primaryKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=
              secondaryKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=
              scope: urn:windowsazuremediaservices
        default:
          description: List Media Service keys failed.
          schema:
            $ref: '#/definitions/ApiError'
      summary: >-
        Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices Mediaservicename Listkeys
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/syncStorageKeys
  : post:
      operationId: microsoftAzureMediaserviceSyncstoragekeys
      description: >-
        Synchronizes storage account keys for a storage account associated with
        the Media Service account.
      externalDocs:
        url: https://aka.ms/media-manage
      x-ms-examples:
        MediaServiceSyncStorageKeys:
          $ref: ./examples/MediaServiceSyncStorageKeys.json
      parameters:
        - $ref: '#/parameters/subscriptionIdParameter'
        - $ref: '#/parameters/apiVersionParameter'
        - $ref: '#/parameters/resourceGroupNameParameter'
        - $ref: '#/parameters/mediaResourceNameParameter'
        - name: parameters
          description: >-
            Properties needed to synchronize the keys for a storage account to
            the Media Service.
          in: body
          required: true
          schema:
            $ref: '#/definitions/SyncStorageKeysInput'
      responses:
        '200':
          description: Success. The keys for the storage account were synchronized.
        default:
          description: Synch Media Service storage keys failed.
          schema:
            $ref: '#/definitions/ApiError'
      summary: >-
        Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices Mediaservicename Syncstoragekeys
      tags:
        - Subscriptions
definitions:
  ApiEndpoint:
    description: The properties for a Media Services REST API endpoint.
    example:
      endpoint: https://wamsbayclus001rest-hs.cloudapp.net/api/
      majorVersion: '2'
    properties:
      endpoint:
        description: The Media Services REST endpoint.
        type: string
      majorVersion:
        description: The version of Media Services REST API.
        type: string
  ApiError:
    description: The error returned from a failed Media Services REST API call.
    example:
      error:
        code: BadRequest
        message: >-
          Name availability check is not supported for type
          Microsoft.Media/mediaservices.
    properties:
      code:
        description: Error code.
        type: string
      message:
        description: Error message.
        type: string
  CheckNameAvailabilityInput:
    description: The request body for CheckNameAvailability API.
    example:
      name: contosomedia
      type: mediaservices
    required:
      - name
      - type
    properties:
      name:
        description: The name of the resource. A name must be globally unique.
        type: string
        pattern: ^[a-z0-9]{3,24}$
        minLength: 3
        maxLength: 24
      type:
        description: The type of the resource - mediaservices.
        $ref: '#/definitions/ResourceType'
  ResourceType:
    description: Type of MediaService resource.
    enum:
      - mediaservices
    type: string
    x-ms-enum:
      name: ResourceType
      modelAsString: false
  CheckNameAvailabilityOutput:
    description: The response body for CheckNameAvailability API.
    properties:
      nameAvailable:
        description: Specifies if the name is available.
        type: boolean
      reason:
        description: Specifies the reason if the name is not available.
        type: string
        enum:
          - None
          - Invalid
          - AlreadyExists
        x-ms-enum:
          name: EntityNameUnavailabilityReason
          modelAsString: false
      message:
        description: Specifies the detailed reason if the name is not available.
        type: string
  MediaService:
    description: The properties of a Media Service resource.
    example:
      location: West US
      properties:
        storageAccounts:
          - id: >-
              /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia
            isPrimary: true
    properties:
      properties:
        description: The additional properties of a Media Service resource.
        x-ms-client-flatten: true
        $ref: '#/definitions/MediaServiceProperties'
    allOf:
      - $ref: '#/definitions/Resource'
  MediaServiceCollection:
    description: The collection of Media Service resources.
    properties:
      value:
        description: The collection of Media Service resources.
        type: array
        items:
          $ref: '#/definitions/MediaService'
  MediaServiceProperties:
    description: The additional properties of a Media Service resource.
    properties:
      apiEndpoints:
        description: >-
          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.
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/ApiEndpoint'
      storageAccounts:
        description: The storage accounts for this resource.
        type: array
        items:
          $ref: '#/definitions/StorageAccount'
  RegenerateKeyInput:
    description: The request body for a RegenerateKey API.
    example:
      keyType: Primary
    properties:
      keyType:
        description: >-
          The keyType indicating which key you want to regenerate, Primary or
          Secondary.
        type: string
        enum:
          - Primary
          - Secondary
        x-ms-enum:
          name: KeyType
          modelAsString: false
    required:
      - keyType
  RegenerateKeyOutput:
    description: The response body for a RegenerateKey API.
    example:
      key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=
    properties:
      key:
        description: The new value of either the primary or secondary key.
        type: string
  Resource:
    description: The Azure Resource Manager resource.
    properties:
      id:
        description: The id of the resource.
        readOnly: true
        type: string
      name:
        description: The name of the resource.
        readOnly: true
        type: string
      type:
        description: The type of the resource
        readOnly: true
        type: string
      location:
        type: string
        description: >-
          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).
      tags:
        type: object
        additionalProperties:
          type: string
        description: Tags to help categorize the resource in the Azure portal.
    x-ms-azure-resource: true
  ServiceKeys:
    description: The response body for a ListKeys API.
    example:
      primaryAuthEndpoint: https://wamsprodglobal001acs.accesscontrol.windows.net/
      secondaryAuthEndpoint: https://wamsprodglobal002acs.accesscontrol.windows.net/
      primaryKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=
      secondaryKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=
      scope: urn:windowsazuremediaservices
    properties:
      primaryAuthEndpoint:
        description: The primary authorization endpoint.
        type: string
      secondaryAuthEndpoint:
        description: The secondary authorization endpoint.
        type: string
      primaryKey:
        description: The primary key for the Media Service resource.
        type: string
      secondaryKey:
        description: The secondary key for the Media Service resource.
        type: string
      scope:
        description: The authorization scope.
        type: string
  StorageAccount:
    description: The properties of a storage account associated with this resource.
    example:
      id: >-
        /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia
      isPrimary: true
    required:
      - id
      - isPrimary
    properties:
      id:
        description: >-
          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).
        type: string
      isPrimary:
        description: >-
          Is this storage account resource the primary storage account for the
          Media Service resource. Blob only storage must set this to false.
        type: boolean
  SyncStorageKeysInput:
    description: The request  body for a SyncStorageKeys API.
    example:
      id: >-
        /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia
    required:
      - id
    properties:
      id:
        description: The id of the storage account resource.
        type: string
  OperationListResult:
    description: Result of the request to list Media Services operations.
    properties:
      value:
        description: >-
          List of Media Services operations supported by the Microsoft.Media
          resource provider.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/Operation'
      nextLink:
        description: URL to get the next set of operation list results if there are any.
        type: string
        readOnly: true
  Operation:
    description: A Media Services REST API operation
    type: object
    properties:
      name:
        description: 'Operation name: {provider}/{resource}/{operation}'
        type: string
        readOnly: true
      display:
        description: The object that represents the operation.
        properties:
          provider:
            description: 'Service provider: Microsoft.Media'
            type: string
            readOnly: true
          resource:
            description: 'Resource on which the operation is performed: Invoice, etc.'
            type: string
            readOnly: true
          operation:
            description: 'Operation type: Read, write, delete, etc.'
            type: string
            readOnly: true
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    description: The unique identifier for a Microsoft Azure subscription.
    in: path
    required: true
    type: string
  resourceGroupNameParameter:
    name: resourceGroupName
    description: Name of the resource group within the Azure subscription.
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
  mediaResourceNameParameter:
    name: mediaServiceName
    description: Name of the Media Service.
    in: path
    required: true
    type: string
    pattern: ^[a-z0-9]{3,24}$
    minLength: 3
    maxLength: 24
    x-ms-parameter-location: method
  apiVersionParameter:
    name: api-version
    description: >-
      Version of the API to be used with the client request. The current version
      is 2015-10-01.
    in: query
    required: true
    type: string
tags:
  - name: Providers
  - name: Subscriptions