asset.yml

### YamlMime:AzureCLIGroup
uid: az_ams_asset
name: az ams asset
summary: |-
  Manage assets for an Azure Media Services account.
status: GA
sourceType: Core
directCommands:
- uid: az_ams_asset_create
  name: az ams asset create
  summary: |-
    Create an asset.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/ams/_help.py
  syntax: >-
    az ams asset create --account-name
                        --name
                        --resource-group
                        [--alternate-id]
                        [--container]
                        [--description]
                        [--storage-account]
  requiredParameters:
  - isRequired: true
    name: --account-name -a
    summary: |-
      The name of the Azure Media Services account.
  - isRequired: true
    name: --name -n
    summary: |-
      The name of the asset.
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  optionalParameters:
  - name: --alternate-id
    summary: |-
      The alternate id of the asset.
  - name: --container
    summary: |-
      The name of the asset blob container.
  - name: --description
    summary: |-
      The asset description.
  - name: --storage-account
    summary: |-
      The name of the storage account.
- uid: az_ams_asset_delete
  name: az ams asset delete
  summary: |-
    Delete an asset.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/ams/_help.py
  syntax: >-
    az ams asset delete [--account-name]
                        [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]
  optionalParameters:
  - name: --account-name -a
    summary: |-
      The name of the Azure Media Services account.
  - name: --ids
    summary: |-
      One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
  - name: --name -n
    summary: |-
      The name of the asset.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_ams_asset_get-encryption-key
  name: az ams asset get-encryption-key
  summary: |-
    Get the asset storage encryption keys used to decrypt content created by version 2 of the Media Services API.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/ams/_help.py
  syntax: >-
    az ams asset get-encryption-key [--account-name]
                                    [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--subscription]
  optionalParameters:
  - name: --account-name -a
    summary: |-
      The name of the Azure Media Services account.
  - name: --ids
    summary: |-
      One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
  - name: --name -n
    summary: |-
      The name of the asset.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_ams_asset_get-sas-urls
  name: az ams asset get-sas-urls
  summary: |-
    Lists storage container URLs with shared access signatures (SAS) for uploading and downloading Asset content. The signatures are derived from the storage account keys.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/ams/_help.py
  syntax: >-
    az ams asset get-sas-urls [--account-name]
                              [--expiry]
                              [--ids]
                              [--name]
                              [--permissions {Read, ReadWrite, ReadWriteDelete}]
                              [--resource-group]
                              [--subscription]
  optionalParameters:
  - name: --account-name -a
    summary: |-
      The name of the Azure Media Services account.
  - name: --expiry
    defaultValue: "2025-02-01 10:13:14.188603"
    summary: |-
      Specifies the UTC datetime (Y-m-d'T'H:M:S'Z') at which the SAS becomes invalid. This must be less than 24 hours from the current time.
  - name: --ids
    summary: |-
      One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
  - name: --name -n
    summary: |-
      The name of the asset.
  - name: --permissions
    defaultValue: "Read"
    parameterValueGroup: "Read, ReadWrite, ReadWriteDelete"
    summary: |-
      The permissions to set on the SAS URL.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_ams_asset_list
  name: az ams asset list
  summary: |-
    List all the assets of an Azure Media Services account.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/ams/_help.py
  syntax: >-
    az ams asset list --account-name
                      --resource-group
                      [--filter]
                      [--orderby]
                      [--top]
  examples:
  - summary: |-
      List all the assets whose names start with the string 'Something'.
    syntax: az ams asset list -a amsAccount -g resourceGroup --query [?starts_with(name,'Something')]
  requiredParameters:
  - isRequired: true
    name: --account-name -a
    summary: |-
      The name of the Azure Media Services account.
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  optionalParameters:
  - name: --filter
    summary: |-
      Restricts the set of items returned.
  - name: --orderby
    summary: |-
      Specifies the key by which the result collection should be ordered.
  - name: --top
    summary: |-
      Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.
- uid: az_ams_asset_list-streaming-locators
  name: az ams asset list-streaming-locators
  summary: |-
    List streaming locators which are associated with this asset.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/ams/_help.py
  syntax: >-
    az ams asset list-streaming-locators [--account-name]
                                         [--ids]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]
  optionalParameters:
  - name: --account-name -a
    summary: |-
      The name of the Azure Media Services account.
  - name: --ids
    summary: |-
      One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
  - name: --name -n
    summary: |-
      The name of the asset.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_ams_asset_show
  name: az ams asset show
  summary: |-
    Show the details of an asset.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/ams/_help.py
  syntax: >-
    az ams asset show [--account-name]
                      [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]
  optionalParameters:
  - name: --account-name -a
    summary: |-
      The name of the Azure Media Services account.
  - name: --ids
    summary: |-
      One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
  - name: --name -n
    summary: |-
      The name of the asset.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_ams_asset_update
  name: az ams asset update
  summary: |-
    Update the details of an asset.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/ams/_help.py
  syntax: >-
    az ams asset update [--account-name]
                        [--add]
                        [--alternate-id]
                        [--description]
                        [--force-string]
                        [--ids]
                        [--name]
                        [--remove]
                        [--resource-group]
                        [--set]
                        [--subscription]
  optionalParameters:
  - name: --account-name -a
    summary: |-
      The name of the Azure Media Services account.
  - name: --add
    defaultValue: "[]"
    summary: |-
      Add an object to a list of objects by specifying a path and key value pairs.  Example: `--add property.listProperty <key=value, string or JSON string>`.
  - name: --alternate-id
    summary: |-
      The alternate id of the asset.
  - name: --description
    summary: |-
      The asset description.
  - name: --force-string
    defaultValue: "False"
    summary: |-
      When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
  - name: --ids
    summary: |-
      One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
  - name: --name -n
    summary: |-
      The name of the asset.
  - name: --remove
    defaultValue: "[]"
    summary: |-
      Remove a property or an element from a list.  Example: `--remove property.list <indexToRemove>` OR `--remove propertyToRemove`.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --set
    defaultValue: "[]"
    summary: |-
      Update an object by specifying a property path and value to set.  Example: `--set property1.property2=<value>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
commands:
- az_ams_asset_create
- az_ams_asset_delete
- az_ams_asset_get-encryption-key
- az_ams_asset_get-sas-urls
- az_ams_asset_list
- az_ams_asset_list-streaming-locators
- az_ams_asset_show
- az_ams_asset_update
globalParameters:
- name: --debug
  summary: |-
    Increase logging verbosity to show all debug logs.
- name: --help -h
  summary: |-
    Show this help message and exit.
- name: --only-show-errors
  summary: |-
    Only show errors, suppressing warnings.
- name: --output -o
  defaultValue: "json"
  parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
  summary: |-
    Output format.
- name: --query
  summary: |-
    JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --subscription
  summary: |-
    Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --verbose
  summary: |-
    Increase logging verbosity. Use --debug for full debug logs.
metadata:
  ms.date: 08/26/2022
  description: Manage assets for an Azure Media Services account.