mediaservices
Creates, updates, deletes, gets or lists a mediaservices
resource.
Overview
Name | mediaservices |
Type | Resource |
Id | azure.media_services.mediaservices |
Fields
The following fields are returned by SELECT
queries:
- get
- list
- list_by_subscription
Name | Datatype | Description |
---|---|---|
identity | object | The Managed Identity for the Media Services account. |
location | string | The geo-location where the resource lives |
properties | object | The resource properties. |
systemData | object | The system metadata relating to this resource. |
tags | object | Resource tags. |
Name | Datatype | Description |
---|---|---|
identity | object | The Managed Identity for the Media Services account. |
location | string | The geo-location where the resource lives |
properties | object | The resource properties. |
systemData | object | The system metadata relating to this resource. |
tags | object | Resource tags. |
Name | Datatype | Description |
---|---|---|
identity | object | The Managed Identity for the Media Services account. |
location | string | The geo-location where the resource lives |
properties | object | The resource properties. |
systemData | object | The system metadata relating to this resource. |
tags | object | Resource tags. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | subscriptionId , resourceGroupName , accountName | api-version | Get the details of a Media Services account |
list | select | subscriptionId , resourceGroupName | api-version | List Media Services accounts in the resource group |
list_by_subscription | select | subscriptionId | api-version | List Media Services accounts in the subscription. |
create_or_update | insert | subscriptionId , resourceGroupName , accountName | api-version | Creates or updates a Media Services account |
update | update | subscriptionId , resourceGroupName , accountName | api-version | Updates an existing Media Services account |
delete | delete | subscriptionId , resourceGroupName , accountName | api-version | Deletes a Media Services account |
sync_storage_keys | exec | subscriptionId , resourceGroupName , accountName | api-version | Synchronizes storage account keys for a storage account associated with the Media Service account. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
accountName | string | The Media Services account name. |
resourceGroupName | string | The name of the resource group within the Azure subscription. |
subscriptionId | string | The unique identifier for a Microsoft Azure subscription. |
api-version | string | The version of the API to be used with the client request. |
SELECT
examples
- get
- list
- list_by_subscription
Get the details of a Media Services account
SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.media_services.mediaservices
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND api-version = '{{ api-version }}'
;
List Media Services accounts in the resource group
SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.media_services.mediaservices
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;
List Media Services accounts in the subscription.
SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.media_services.mediaservices
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;
INSERT
examples
- create_or_update
- Manifest
Creates or updates a Media Services account
INSERT INTO azure.media_services.mediaservices (
data__tags,
data__location,
data__properties,
data__identity,
subscriptionId,
resourceGroupName,
accountName,
api-version
)
SELECT
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ api-version }}'
RETURNING
identity,
location,
properties,
systemData,
tags
;
# Description fields are for documentation purposes
- name: mediaservices
props:
- name: subscriptionId
value: string
description: Required parameter for the mediaservices resource.
- name: resourceGroupName
value: string
description: Required parameter for the mediaservices resource.
- name: accountName
value: string
description: Required parameter for the mediaservices resource.
- name: tags
value: object
description: |
Resource tags.
- name: location
value: string
description: |
The geo-location where the resource lives
- name: properties
value: object
description: |
The resource properties.
- name: identity
value: object
description: |
The Managed Identity for the Media Services account.
- name: api-version
value: string
description: The version of the API to be used with the client request.
UPDATE
examples
- update
Updates an existing Media Services account
UPDATE azure.media_services.mediaservices
SET
data__tags = '{{ tags }}',
data__properties = '{{ properties }}',
data__identity = '{{ identity }}'
WHERE
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
identity,
location,
properties,
systemData,
tags;
DELETE
examples
- delete
Deletes a Media Services account
DELETE FROM azure.media_services.mediaservices
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND api-version = '{{ api-version }}'
;
Lifecycle Methods
- sync_storage_keys
Synchronizes storage account keys for a storage account associated with the Media Service account.
EXEC azure.media_services.mediaservices.sync_storage_keys
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@accountName='{{ accountName }}' --required,
@api-version='{{ api-version }}'
@@json=
'{
"id": "{{ id }}"
}'
;