1# -------------------------------------------------------------------------------------------- 2# Copyright (c) Microsoft Corporation. All rights reserved. 3# Licensed under the MIT License. See License.txt in the project root for license information. 4# -------------------------------------------------------------------------------------------- 5 6# pylint: disable=line-too-long 7 8from knack.arguments import CLIArgumentType 9 10from azure.cli.core.commands.validators import get_default_location_from_resource_group 11from azure.cli.core.commands.parameters import (get_location_type, 12 get_enum_type, 13 tags_type, 14 get_three_state_flag) 15 16from azure.cli.command_modules.ams._completers import (get_role_definition_name_completion_list, 17 get_cdn_provider_completion_list, 18 get_default_streaming_policies_completion_list, 19 get_presets_definition_name_completion_list, 20 get_allowed_languages_for_preset_completion_list, 21 get_protocols_completion_list, 22 get_token_type_completion_list, 23 get_fairplay_rentalandlease_completion_list, 24 get_token_completion_list, 25 get_mru_type_completion_list, 26 get_encoding_types_list, 27 get_allowed_resolutions_completion_list, 28 get_allowed_transcription_languages, 29 get_allowed_analysis_modes, 30 get_stretch_mode_types_list, 31 get_storage_authentication_allowed_values_list) 32 33from azure.cli.command_modules.ams._validators import (validate_storage_account_id, 34 datetime_format, 35 validate_correlation_data, 36 validate_token_claim, 37 validate_output_assets, 38 validate_archive_window_length, 39 validate_key_frame_interval_duration) 40 41from azure.mgmt.media.models import (Priority, AssetContainerPermission, LiveEventInputProtocol, StreamOptionsFlag, OnErrorType, InsightsType) 42 43 44def load_arguments(self, _): # pylint: disable=too-many-locals, too-many-statements 45 name_arg_type = CLIArgumentType(options_list=['--name', '-n'], id_part='name', help='The name of the Azure Media Services account.', metavar='NAME') 46 account_name_arg_type = CLIArgumentType(options_list=['--account-name', '-a'], id_part='name', help='The name of the Azure Media Services account.', metavar='ACCOUNT_NAME') 47 storage_account_arg_type = CLIArgumentType(options_list=['--storage-account'], validator=validate_storage_account_id, metavar='STORAGE_NAME') 48 password_arg_type = CLIArgumentType(options_list=['--password', '-p'], metavar='PASSWORD_NAME') 49 transform_name_arg_type = CLIArgumentType(options_list=['--transform-name', '-t'], metavar='TRANSFORM_NAME') 50 expiry_arg_type = CLIArgumentType(options_list=['--expiry'], type=datetime_format, metavar='EXPIRY_TIME') 51 default_policy_name_arg_type = CLIArgumentType(options_list=['--content-key-policy-name'], help='The default content key policy name used by the streaming locator.', metavar='DEFAULT_CONTENT_KEY_POLICY_NAME') 52 archive_window_length_arg_type = CLIArgumentType(options_list=['--archive-window-length'], validator=validate_archive_window_length, metavar='ARCHIVE_WINDOW_LENGTH') 53 key_frame_interval_duration_arg_type = CLIArgumentType(options_list=['--key-frame-interval-duration'], validator=validate_archive_window_length, metavar='ARCHIVE_WINDOW_LENGTH') 54 correlation_data_type = CLIArgumentType(validator=validate_correlation_data, help="Space-separated correlation data in 'key[=value]' format. This customer provided data will be returned in Job and JobOutput state events.", nargs='*', metavar='CORRELATION_DATA') 55 token_claim_type = CLIArgumentType(validator=validate_token_claim, help="Space-separated required token claims in '[key=value]' format.", nargs='*', metavar='ASYMMETRIC TOKEN CLAIMS') 56 output_assets_type = CLIArgumentType(validator=validate_output_assets, nargs='*', help="Space-separated assets in 'assetName=label' format. An asset without label can be sent like this: 'assetName='", metavar='OUTPUT_ASSETS') 57 58 with self.argument_context('ams') as c: 59 c.argument('account_name', name_arg_type) 60 61 with self.argument_context('ams account') as c: 62 c.argument('location', arg_type=get_location_type(self.cli_ctx), 63 validator=get_default_location_from_resource_group, required=False) 64 c.argument('tags', arg_type=tags_type) 65 66 with self.argument_context('ams account create') as c: 67 c.argument('storage_account', storage_account_arg_type, 68 help='The name or resource ID of the primary storage account to attach to the Azure Media Services account. The storage account MUST be in the same Azure subscription as the Media Services account. It is strongly recommended that the storage account be in the same resource group as the Media Services account. Blob only accounts are not allowed as primary.') 69 c.argument('assign_identity', options_list=['--mi-system-assigned'], action='store_true', help='Set the system managed identity on the media services account.') 70 71 with self.argument_context('ams account check-name') as c: 72 c.argument('account_name', options_list=['--name', '-n'], id_part=None, 73 help='The name of the Azure Media Services account.') 74 c.argument('location', arg_type=get_location_type(self.cli_ctx)) 75 76 with self.argument_context('ams account mru') as c: 77 c.argument('type', help='Speed of reserved processing units. The cost of media encoding depends on the pricing tier you choose. See https://azure.microsoft.com/pricing/details/media-services/ for further details. Allowed values: {}.'.format(", ".join(get_mru_type_completion_list()))) 78 c.argument('count', type=int, help='The number of the encoding reserved units that you want to be provisioned for this account for concurrent tasks (one unit equals one task).') 79 80 with self.argument_context('ams account storage') as c: 81 c.argument('account_name', account_name_arg_type) 82 c.argument('storage_account', name_arg_type, 83 help='The name or resource ID of the secondary storage account to detach from the Azure Media Services account.', 84 validator=validate_storage_account_id) 85 86 with self.argument_context('ams account storage sync-storage-keys') as c: 87 c.argument('storage_account_id', required=True, help="The storage account Id.") 88 89 with self.argument_context('ams account storage set-authentication') as c: 90 c.argument('storage_auth', arg_type=get_enum_type(get_storage_authentication_allowed_values_list()), help='The type of authentication for the storage account associated with the media services account.') 91 92 with self.argument_context('ams account sp') as c: 93 c.argument('account_name', account_name_arg_type) 94 c.argument('sp_name', name_arg_type, 95 help="The app name or app URI to associate the RBAC with. If not present, a default name like '{amsaccountname}-access-sp' will be generated.") 96 c.argument('new_sp_name', help="The new app name or app URI to update the RBAC with.") 97 c.argument('sp_password', password_arg_type, 98 help="The password used to log in. Also known as 'Client Secret'. If not present, a random secret will be generated.") 99 c.argument('role', help='The role of the service principal.', completer=get_role_definition_name_completion_list) 100 c.argument('xml', action='store_true', help='Enables xml output format.') 101 c.argument('years', help='Number of years for which the secret will be valid. Default: 1 year.', type=int, default=None) 102 103 with self.argument_context('ams account encryption') as c: 104 c.argument('account_name', account_name_arg_type) 105 c.argument('key_type', help='The encryption key source (provider). Allowed values: SystemKey, CustomerKey.', required=True) 106 c.argument('key_identifier', help='The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey).') 107 c.argument('current_key_id', help='The current key used to encrypt the Media Services account, including the key version.') 108 109 with self.argument_context('ams transform') as c: 110 c.argument('account_name', account_name_arg_type) 111 c.argument('transform_name', name_arg_type, id_part='child_name_1', 112 help='The name of the transform.') 113 c.argument('preset', help='Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the transform output. Allowed values: {}. In addition to the allowed values, you can also pass a path to a custom Standard Encoder preset JSON file. See https://docs.microsoft.com/rest/api/media/transforms/createorupdate#standardencoderpreset for further details on the settings to use to build a custom preset.' 114 .format(", ".join(get_presets_definition_name_completion_list()))) 115 c.argument('insights_to_extract', arg_group='Video Analyzer', arg_type=get_enum_type(InsightsType), help='The type of insights to be extracted. If not set then the type will be selected based on the content type. If the content is audio only then only audio insights will be extracted and if it is video only video insights will be extracted.') 116 c.argument('video_analysis_mode', arg_group='Video Analyzer', help='Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen. Allowed values: {}'.format(", ".join(get_allowed_analysis_modes()))) 117 c.argument('audio_language', arg_group='Audio/Video Analyzer', help='The language for the audio payload in the input using the BCP-47 format of \"language tag-region\" (e.g: en-US). If not specified, automatic language detection would be employed. This feature currently supports English, Chinese, French, German, Italian, Japanese, Spanish, Russian, and Portuguese. The automatic detection works best with audio recordings with clearly discernable speech. If automatic detection fails to find the language, transcription would fallback to English. Allowed values: {}.' 118 .format(", ".join(get_allowed_languages_for_preset_completion_list()))) 119 c.argument('audio_analysis_mode', arg_group='Audio/Video Analyzer', help='Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen. Allowed values: {}.'.format(", ".join(get_allowed_analysis_modes()))) 120 c.argument('resolution', arg_group='Face Detector', help='Specifies the maximum resolution at which your video is analyzed. The default behavior is "SourceResolution," which will keep the input video at its original resolution when analyzed. Using StandardDefinition will resize input videos to standard definition while preserving the appropriate aspect ratio. It will only resize if the video is of higher resolution. For example, a 1920x1080 input would be scaled to 640x360 before processing. Switching to "StandardDefinition" will reduce the time it takes to process high resolution video. It may also reduce the cost of using this component (see https://azure.microsoft.com/pricing/details/media-services/#analytics for details). However, faces that end up being too small in the resized video may not be detected. Allowed values: {}.' 121 .format(", ".join(get_allowed_resolutions_completion_list()))) 122 c.argument('relative_priority', arg_type=get_enum_type(Priority), help='Sets the relative priority of the transform outputs within a transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal.') 123 c.argument('on_error', arg_type=get_enum_type(OnErrorType), help="A Transform can define more than one output. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'.") 124 c.argument('description', help='The description of the transform.') 125 126 with self.argument_context('ams transform output remove') as c: 127 c.argument('output_index', help='The element index of the output to remove.', 128 type=int, default=None) 129 130 with self.argument_context('ams transform list') as c: 131 c.argument('account_name', id_part=None) 132 133 with self.argument_context('ams asset') as c: 134 c.argument('account_name', account_name_arg_type) 135 c.argument('asset_name', name_arg_type, id_part='child_name_1', 136 help='The name of the asset.') 137 138 with self.argument_context('ams asset list') as c: 139 c.argument('account_name', id_part=None) 140 141 with self.argument_context('ams asset create') as c: 142 c.argument('alternate_id', help='The alternate id of the asset.') 143 c.argument('description', help='The asset description.') 144 c.argument('asset_name', name_arg_type, help='The name of the asset.') 145 c.argument('storage_account', help='The name of the storage account.') 146 c.argument('container', help='The name of the asset blob container.') 147 148 with self.argument_context('ams asset update') as c: 149 c.argument('alternate_id', help='The alternate id of the asset.') 150 c.argument('description', help='The asset description.') 151 152 with self.argument_context('ams asset get-sas-urls') as c: 153 c.argument('permissions', arg_type=get_enum_type(AssetContainerPermission), 154 help='The permissions to set on the SAS URL.') 155 c.argument('expiry_time', expiry_arg_type, help="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.") 156 157 with self.argument_context('ams asset-filter') as c: 158 c.argument('account_name', account_name_arg_type) 159 c.argument('asset_name', help='The name of the asset.', id_part='child_name_1') 160 c.argument('filter_name', name_arg_type, id_part='child_name_2', help='The name of the asset filter.') 161 c.argument('start_timestamp', arg_group='Presentation Time Range', 162 help='Applies to Video on Demand (VoD) or Live Streaming. This is a long value that represents an absolute start point of the stream. The value gets rounded to the closest next GOP start. The unit is the timescale, so a startTimestamp of 150000000 would be for 15 seconds. Use startTimestamp and endTimestampp to trim the fragments that will be in the playlist (manifest). For example, startTimestamp=40000000 and endTimestamp=100000000 using the default timescale will generate a playlist that contains fragments from between 4 seconds and 10 seconds of the VoD presentation. If a fragment straddles the boundary, the entire fragment will be included in the manifest.') 163 c.argument('end_timestamp', arg_group='Presentation Time Range', 164 help='Applies to Video on Demand (VoD).For the Live Streaming presentation, it is silently ignored and applied when the presentation ends and the stream becomes VoD.This is a long value that represents an absolute end point of the presentation, rounded to the closest next GOP start. The unit is the timescale, so an endTimestamp of 1800000000 would be for 3 minutes.Use startTimestamp and endTimestamp to trim the fragments that will be in the playlist (manifest).For example, startTimestamp=40000000 and endTimestamp=100000000 using the default timescale will generate a playlist that contains fragments from between 4 seconds and 10 seconds of the VoD presentation. If a fragment straddles the boundary, the entire fragment will be included in the manifest.') 165 c.argument('presentation_window_duration', arg_group='Presentation Time Range', 166 help='Applies to Live Streaming only.Use presentationWindowDuration to apply a sliding window of fragments to include in a playlist.The unit for this property is timescale (see below).For example, set presentationWindowDuration=1200000000 to apply a two-minute sliding window. Media within 2 minutes of the live edge will be included in the playlist. If a fragment straddles the boundary, the entire fragment will be included in the playlist. The minimum presentation window duration is 60 seconds.') 167 c.argument('live_backoff_duration', arg_group='Presentation Time Range', 168 help='Applies to Live Streaming only. This value defines the latest live position that a client can seek to. Using this property, you can delay live playback position and create a server-side buffer for players. The unit for this property is timescale (see below). The maximum live back off duration is 300 seconds (3000000000). For example, a value of 2000000000 means that the latest available content is 20 seconds delayed from the real live edge.') 169 c.argument('timescale', arg_group='Presentation Time Range', 170 help='Applies to all timestamps and durations in a Presentation Time Range, specified as the number of increments in one second.Default is 10000000 - ten million increments in one second, where each increment would be 100 nanoseconds long. For example, if you want to set a startTimestamp at 30 seconds, you would use a value of 300000000 when using the default timescale.') 171 c.argument('force_end_timestamp', arg_group='Presentation Time Range', arg_type=get_three_state_flag(), 172 help='Applies to Live Streaming only. Indicates whether the endTimestamp property must be present. If true, endTimestamp must be specified or a bad request code is returned. Allowed values: false, true.') 173 c.argument('bitrate', help='The first quality bitrate.', deprecate_info=c.deprecate(target='--bitrate', redirect='--first-quality', hide=True)) 174 c.argument('first_quality', help='The first quality (lowest) bitrate to include in the manifest.') 175 c.argument('tracks', help='The JSON representing the track selections. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/assetfilters/createorupdate#filtertrackselection') 176 177 with self.argument_context('ams asset-filter list') as c: 178 c.argument('account_name', id_part=None) 179 180 with self.argument_context('ams job') as c: 181 c.argument('account_name', account_name_arg_type) 182 c.argument('transform_name', transform_name_arg_type, id_part='child_name_1', 183 help='The name of the transform.') 184 c.argument('job_name', name_arg_type, id_part='child_name_2', 185 help='The name of the job.') 186 c.argument('description', help='The job description.') 187 c.argument('priority', arg_type=get_enum_type(Priority), 188 help='The priority with which the job should be processed.') 189 190 with self.argument_context('ams job list') as c: 191 c.argument('account_name', id_part=None) 192 193 with self.argument_context('ams job start') as c: 194 c.argument('correlation_data', arg_type=correlation_data_type) 195 c.argument('input_asset_name', 196 arg_group='Asset Job Input', 197 help='The name of the input asset.') 198 c.argument('output_assets', arg_type=output_assets_type) 199 c.argument('base_uri', 200 arg_group='Http Job Input', 201 help='Base uri for http job input. It will be concatenated with provided file names. If no base uri is given, then the provided file list is assumed to be fully qualified uris.') 202 c.argument('files', 203 nargs='+', 204 help='Space-separated list of files. It can be used to tell the service to only use the files specified from the input asset.') 205 c.argument('label', help="A label that is assigned to a Job Input that is used to satisfy a reference used in the Transform. For example, a Transform can be authored to take an image file with the label 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a Job, exactly one of the JobInputs should be the image file, and it should have the label 'xyz'.") 206 c.argument('correlation_data', arg_type=correlation_data_type) 207 208 with self.argument_context('ams job cancel') as c: 209 c.argument('delete', action='store_true', help='Delete the job being cancelled.') 210 211 with self.argument_context('ams content-key-policy') as c: 212 c.argument('account_name', account_name_arg_type) 213 c.argument('content_key_policy_name', name_arg_type, id_part='child_name_1', 214 help='The content key policy name.') 215 c.argument('description', help='The content key policy description.') 216 c.argument('clear_key_configuration', 217 action='store_true', 218 arg_group='Clear Key Configuration (AES Encryption)', 219 help='Use Clear Key configuration, a.k.a AES encryption. It\'s intended for non-DRM keys.') 220 c.argument('open_restriction', 221 action='store_true', 222 arg_group='Open Restriction', 223 help='Use open restriction. License or key will be delivered on every request. Not recommended for production environments.') 224 c.argument('policy_option_name', help='The content key policy option name.') 225 c.argument('policy_option_id', help='The content key policy option identifier. This value can be obtained from "policyOptionId" property by running a show operation on a content key policy resource.') 226 c.argument('issuer', arg_group='Token Restriction', help='The token issuer.') 227 c.argument('audience', arg_group='Token Restriction', help='The audience for the token.') 228 c.argument('token_key', arg_group='Token Restriction', help='Either a string (for symmetric key) or a filepath to a certificate (x509) or public key (rsa). Must be used in conjunction with --token-key-type.') 229 c.argument('token_key_type', arg_group='Token Restriction', help='The type of the token key to be used for the primary verification key. Allowed values: {}'.format(", ".join(get_token_completion_list()))) 230 c.argument('add_alt_token_key', arg_group='Token Restriction', help='Creates an alternate token key with either a string (for symmetric key) or a filepath to a certificate (x509) or public key (rsa). Must be used in conjunction with --add-alt-token-key-type.') 231 c.argument('add_alt_token_key_type', arg_group='Token Restriction', help='The type of the token key to be used for the alternate verification key. Allowed values: {}'.format(", ".join(get_token_completion_list()))) 232 c.argument('alt_symmetric_token_keys', nargs='+', arg_group='Token Restriction', help='Space-separated list of alternate symmetric token keys.') 233 c.argument('alt_rsa_token_keys', nargs='+', arg_group='Token Restriction', help='Space-separated list of alternate rsa token keys.') 234 c.argument('alt_x509_token_keys', nargs='+', arg_group='Token Restriction', help='Space-separated list of alternate x509 certificate token keys.') 235 c.argument('token_claims', arg_group='Token Restriction', arg_type=token_claim_type) 236 c.argument('token_type', arg_group='Token Restriction', 237 help='The type of token. Allowed values: {}.'.format(", ".join(get_token_type_completion_list()))) 238 c.argument('open_id_connect_discovery_document', arg_group='Token Restriction', help='The OpenID connect discovery document.') 239 c.argument('widevine_template', arg_group='Widevine Configuration', help='JSON Widevine license template. Use @{file} to load from a file.') 240 c.argument('fp_playback_duration_seconds', arg_group='FairPlay Configuration', help='Playback duration') 241 c.argument('fp_storage_duration_seconds', arg_group='FairPlay Configuration', help='Storage duration') 242 c.argument('ask', arg_group='FairPlay Configuration', help='The key that must be used as FairPlay Application Secret Key, which is a 32 character hex string.') 243 c.argument('fair_play_pfx_password', arg_group='FairPlay Configuration', help='The password encrypting FairPlay certificate in PKCS 12 (pfx) format.') 244 c.argument('fair_play_pfx', arg_group='FairPlay Configuration', help='The filepath to a FairPlay certificate file in PKCS 12 (pfx) format (including private key).') 245 c.argument('rental_and_lease_key_type', arg_group='FairPlay Configuration', help='The rental and lease key type. Available values: {}.'.format(", ".join(get_fairplay_rentalandlease_completion_list()))) 246 c.argument('rental_duration', arg_group='FairPlay Configuration', help='The rental duration. Must be greater than or equal to 0.') 247 c.argument('play_ready_template', arg_group='PlayReady Configuration', help='JSON PlayReady license template. Use @{file} to load from a file.') 248 249 with self.argument_context('ams content-key-policy list') as c: 250 c.argument('account_name', id_part=None) 251 252 with self.argument_context('ams content-key-policy show') as c: 253 c.argument('with_secrets', 254 action='store_true', 255 help='Include secret values of the content key policy.') 256 257 with self.argument_context('ams streaming-locator') as c: 258 c.argument('account_name', account_name_arg_type) 259 c.argument('default_content_key_policy_name', default_policy_name_arg_type) 260 c.argument('streaming_locator_name', name_arg_type, id_part='child_name_1', 261 help='The name of the streaming locator.') 262 c.argument('asset_name', 263 help='The name of the asset used by the streaming locator.') 264 c.argument('streaming_policy_name', 265 help='The name of the streaming policy used by the streaming locator. You can either create one with `az ams streaming policy create` or use any of the predefined policies: {}'.format(", ".join(get_default_streaming_policies_completion_list()))) 266 c.argument('start_time', type=datetime_format, 267 help="The ISO 8601 DateTime start time (Y-m-d'T'H:M:S'Z') of the streaming locator.") 268 c.argument('end_time', type=datetime_format, 269 help="The ISO 8601 DateTime end time (Y-m-d'T'H:M:S'Z') of the streaming locator.") 270 c.argument('streaming_locator_id', help='The identifier of the streaming locator.') 271 c.argument('alternative_media_id', help='An alternative media identifier associated with the streaming locator.') 272 c.argument('content_keys', help='JSON string with the content keys to be used by the streaming locator. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/streaminglocators/create#streaminglocatorcontentkey') 273 c.argument('filters', nargs='+', help='A space-separated list of asset filter names and/or account filter names.') 274 275 with self.argument_context('ams streaming-locator list') as c: 276 c.argument('account_name', id_part=None) 277 278 with self.argument_context('ams streaming-policy') as c: 279 c.argument('account_name', account_name_arg_type) 280 c.argument('streaming_policy_name', name_arg_type, id_part='child_name_1', help='The name of the streaming policy.') 281 c.argument('default_content_key_policy_name', help='Default Content Key used by current streaming policy.') 282 c.argument('no_encryption_protocols', nargs='+', help='Space-separated list of enabled protocols for NoEncryption. Allowed values: {}.'.format(", ".join(get_protocols_completion_list()))) 283 c.argument('envelope_protocols', nargs='+', arg_group='Envelope Encryption', help='Space-separated list of enabled protocols for Envelope Encryption. Allowed values: {}.'.format(", ".join(get_protocols_completion_list()))) 284 c.argument('envelope_clear_tracks', arg_group='Envelope Encryption', help='The JSON representing which tracks should not be encrypted. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/streamingpolicies/create#trackselection') 285 c.argument('envelope_key_to_track_mappings', arg_group='Envelope Encryption', help='The JSON representing a list of StreamingPolicyContentKey. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/streamingpolicies/create#streamingpolicycontentkey') 286 c.argument('envelope_default_key_label', arg_group='Envelope Encryption', help='Label used to specify Content Key when creating a streaming locator.') 287 c.argument('envelope_default_key_policy_name', arg_group='Envelope Encryption', help='Policy used by Default Key.') 288 c.argument('envelope_template', arg_group='Envelope Encryption', help='The KeyAcquistionUrlTemplate is used to point to user specified service to delivery content keys.') 289 c.argument('cenc_protocols', nargs='+', arg_group='Common Encryption CENC', help='Space-separated list of enabled protocols for Common Encryption CENC. Allowed values: {}.'.format(", ".join(get_protocols_completion_list()))) 290 c.argument('cenc_default_key_label', arg_group='Common Encryption CENC', help='Label to specify Default Content Key for an encryption scheme.') 291 c.argument('cenc_default_key_policy_name', arg_group='Common Encryption CENC', help='Policy used by Default Content Key.') 292 c.argument('cenc_clear_tracks', arg_group='Common Encryption CENC', help='The JSON representing which tracks should not be encrypted. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/streamingpolicies/create#trackselection') 293 c.argument('cenc_key_to_track_mappings', arg_group='Common Encryption CENC', help='The JSON representing a list of StreamingPolicyContentKey. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/streamingpolicies/create#streamingpolicycontentkey') 294 c.argument('cenc_play_ready_attributes', arg_group='Common Encryption CENC', help='Custom attributes for PlayReady.') 295 c.argument('cenc_widevine_template', arg_group='Common Encryption CENC', help='The custom license acquisition URL template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys.') 296 c.argument('cenc_play_ready_template', arg_group='Common Encryption CENC', help='The custom license acquisition URL template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys.') 297 c.argument('cenc_disable_widevine', arg_group='Common Encryption CENC', arg_type=get_three_state_flag(), help='If specified, no Widevine cenc DRM will be configured. If --cenc-disable-widevine is set, --cenc-disable-play-ready cannot also be set.') 298 c.argument('cenc_disable_play_ready', arg_group='Common Encryption CENC', arg_type=get_three_state_flag(), help='If specified, no PlayReady cenc DRM will be configured. If --cenc-disable-play-ready is set, --cenc-disable-widevine cannot also be set.') 299 c.argument('cbcs_protocols', nargs='+', arg_group='Common Encryption CBCS', help='Space-separated list of enabled protocols for Common Encryption CBCS. Allowed values: {}.'.format(", ".join(get_protocols_completion_list()))) 300 c.argument('cbcs_default_key_label', arg_group='Common Encryption CBCS', help='Label to specify Default Content Key for an encryption scheme.') 301 c.argument('cbcs_default_key_policy_name', arg_group='Common Encryption CBCS', help='Policy used by Default Content Key.') 302 c.argument('cbcs_clear_tracks', arg_group='Common Encryption CBCS', help='The JSON representing which tracks should not be encrypted. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/streamingpolicies/create#trackselection') 303 c.argument('cbcs_key_to_track_mappings', arg_group='Common Encryption CBCS', help='The JSON representing a list of StreamingPolicyContentKey. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/streamingpolicies/create#streamingpolicycontentkey') 304 c.argument('cbcs_play_ready_attributes', arg_group='Common Encryption CBCS', help='Custom attributes for PlayReady.', deprecate_info=c.deprecate(hide=True)) 305 c.argument('cbcs_play_ready_template', arg_group='Common Encryption CBCS', help='The custom license acquisition URL template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys.', deprecate_info=c.deprecate(hide=True)) 306 c.argument('cbcs_widevine_template', arg_group='Common Encryption CBCS', help='The custom license acquisition URL template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys.', deprecate_info=c.deprecate(hide=True)) 307 c.argument('cbcs_fair_play_template', arg_group='Common Encryption CBCS', help='The custom license acquisition URL template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys.') 308 c.argument('cbcs_fair_play_allow_persistent_license', arg_group='Common Encryption CBCS', arg_type=get_three_state_flag(), help='Allows the license to be persistent or not.') 309 310 with self.argument_context('ams streaming-policy list') as c: 311 c.argument('account_name', id_part=None) 312 313 with self.argument_context('ams streaming-endpoint') as c: 314 c.argument('streaming_endpoint_name', name_arg_type, id_part='child_name_1', 315 help='The name of the streaming endpoint.') 316 c.argument('account_name', account_name_arg_type) 317 c.argument('tags', arg_type=tags_type) 318 c.argument('description', help='The streaming endpoint description.') 319 c.argument('scale_units', help='The number of scale units for Premium StreamingEndpoints. For Standard StreamingEndpoints, set this value to 0. Use the Scale operation to adjust this value for Premium StreamingEndpoints.') 320 c.argument('availability_set_name', help='The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time.') 321 c.argument('max_cache_age', help='Max cache age.') 322 c.argument('custom_host_names', nargs='+', help='Space-separated list of custom host names for the streaming endpoint. Use "" to clear existing list.') 323 c.argument('cdn_provider', arg_group='CDN Support', help='The CDN provider name. Allowed values: {}.'.format(", ".join(get_cdn_provider_completion_list()))) 324 c.argument('cdn_profile', arg_group='CDN Support', help='The CDN profile name.') 325 c.argument('client_access_policy', arg_group='Cross Site Access Policies', 326 help='The XML representing the clientaccesspolicy data used by Microsoft Silverlight and Adobe Flash. Use @{file} to load from a file. For further information about the XML structure please refer to documentation on https://docs.microsoft.com/rest/api/media/operations/crosssiteaccesspolicies') 327 c.argument('cross_domain_policy', arg_group='Cross Site Access Policies', 328 help='The XML representing the crossdomain data used by Silverlight. Use @{file} to load from a file. For further information about the XML structure please refer to documentation on https://docs.microsoft.com/rest/api/media/operations/crosssiteaccesspolicies') 329 c.argument('auto_start', action='store_true', help='The flag indicates if the resource should be automatically started on creation.') 330 c.argument('ips', nargs='+', arg_group='Access Control Support', help='Space-separated IP addresses for access control. Allowed IP addresses can be specified as either a single IP address (e.g. "10.0.0.1") or as an IP range using an IP address and a CIDR subnet mask (e.g. "10.0.0.1/22"). Use "" to clear existing list. If no IP addresses are specified any IP address will be allowed.') 331 c.argument('disable_cdn', arg_group='CDN Support', action='store_true', help='Use this flag to disable CDN for the streaming endpoint.') 332 333 with self.argument_context('ams streaming-endpoint list') as c: 334 c.argument('account_name', id_part=None) 335 336 with self.argument_context('ams streaming-endpoint scale') as c: 337 c.argument('scale_unit', options_list=['--scale-units'], help='The number of scale units for Premium StreamingEndpoints.') 338 339 with self.argument_context('ams streaming-endpoint akamai') as c: 340 c.argument('identifier', help='The identifier for the authentication key. This is the nonce provided by Akamai.') 341 c.argument('base64_key', help='Base64-encoded authentication key that will be used by the CDN. The authentication key provided by Akamai is an ASCII encoded string, and must be converted to bytes and then base64 encoded.') 342 c.argument('expiration', type=datetime_format, 343 help='The ISO 8601 DateTime value that specifies when the Akamai authentication expires.') 344 345 with self.argument_context('ams streaming-endpoint list') as c: 346 c.argument('account_name', id_part=None) 347 348 with self.argument_context('ams live-event') as c: 349 c.argument('account_name', account_name_arg_type) 350 c.argument('live_event_name', name_arg_type, id_part='child_name_1', 351 help='The name of the live event.') 352 c.argument('streaming_protocol', arg_type=get_enum_type(LiveEventInputProtocol), 353 arg_group='Input', help='The streaming protocol for the live event. This value is specified at creation time and cannot be updated.') 354 c.argument('auto_start', action='store_true', help='The flag indicates if the resource should be automatically started on creation.') 355 c.argument('encoding_type', arg_group='Encoding', help='The encoding type for live event. This value is specified at creation time and cannot be updated. Allowed values: {}.'.format(", ".join(get_encoding_types_list()))) 356 c.argument('preset_name', arg_group='Encoding', help='The encoding preset name. This value is specified at creation time and cannot be updated.') 357 c.argument('stretch_mode', arg_group='Encoding', help='Specifies how the input video will be resized to fit the desired output resolution(s). Default is None. Allowed values: {}.'.format(", ".join(get_stretch_mode_types_list()))) 358 c.argument('key_frame_interval', arg_group='Encoding', help='Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audiotracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for anencoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events.') 359 c.argument('tags', arg_type=tags_type) 360 c.argument('key_frame_interval_duration', key_frame_interval_duration_arg_type, arg_group='Input', validator=validate_key_frame_interval_duration, 361 help='ISO 8601 timespan duration of the key frame interval duration in seconds. The value should be an interger in the range of 1 (PT1S or 00:00:01) to 30 (PT30S or 00:00:30) seconds.') 362 c.argument('access_token', arg_group='Input', help='A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value.') 363 c.argument('description', help='The live event description.') 364 c.argument('ips', nargs='+', arg_group='Input', help='Space-separated IP addresses for access control. Allowed IP addresses can be specified as either a single IP address (e.g. "10.0.0.1") or as an IP range using an IP address and a CIDR subnet mask (e.g. "10.0.0.1/22"). Use "" to clear existing list. Use "AllowAll" to allow all IP addresses. Allowing all IPs is not recommended for production environments.') 365 c.argument('preview_ips', nargs='+', arg_group='Preview', help='Space-separated IP addresses for access control. Allowed IP addresses can be specified as either a single IP address (e.g. "10.0.0.1") or as an IP range using an IP address and a CIDR subnet mask (e.g. "10.0.0.1/22"). Use "" to clear existing list. Use "AllowAll" to allow all IP addresses. Allowing all IPs is not recommended for production environments.') 366 c.argument('preview_locator', arg_group='Preview', help='The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created.') 367 c.argument('streaming_policy_name', arg_group='Preview', help='The name of streaming policy used for the live event preview. This can be specified at creation time but cannot be updated.') 368 c.argument('alternative_media_id', arg_group='Preview', help='An Alternative Media Identifier associated with the StreamingLocator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field.') 369 c.argument('client_access_policy', arg_group='Cross Site Access Policies', help='Filepath to the clientaccesspolicy.xml used by Microsoft Silverlight and Adobe Flash. Use @{file} to load from a file.') 370 c.argument('cross_domain_policy', arg_group='Cross Site Access Policies', help='Filepath to the crossdomain.xml used by Microsoft Silverlight and Adobe Flash. Use @{file} to load from a file.') 371 c.argument('stream_options', nargs='+', arg_type=get_enum_type(StreamOptionsFlag), help='The options to use for the LiveEvent. This value is specified at creation time and cannot be updated.') 372 c.argument('transcription_lang', help='Live transcription language for the live event. Allowed values: {} See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature.'.format(", ".join(get_allowed_transcription_languages()))) 373 c.argument('use_static_hostname', help='Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state. If hostname_prefix is not specified, the live event name will be used as the hostname prefix.') 374 c.argument('hostname_prefix', help='When useStaticHostname is set to true, hostname_prefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center.') 375 c.argument('remove_outputs_on_stop', action='store_true', help='Remove live outputs on stop.') 376 377 with self.argument_context('ams live-event list') as c: 378 c.argument('account_name', id_part=None) 379 380 with self.argument_context('ams live-output') as c: 381 c.argument('account_name', account_name_arg_type) 382 c.argument('live_event_name', id_part='child_name_1', 383 help='The name of the live event.') 384 c.argument('live_output_name', name_arg_type, id_part='child_name_2', 385 help='The name of the live output.') 386 387 with self.argument_context('ams live-output list') as c: 388 c.argument('account_name', id_part=None) 389 390 with self.argument_context('ams live-output create') as c: 391 c.argument('asset_name', help='The name of the asset.') 392 c.argument('archive_window_length', archive_window_length_arg_type, validator=validate_archive_window_length, 393 help="ISO 8601 timespan duration of the archive window length. This is the duration that customer want to retain the recorded content. Minimum window is 5 minutes (PT5M or 00:05:00). Maximum window is 25 hours (PT25H or 25:00:00). For example, to retain the output for 10 minutes, use PT10M or 00:10:00") 394 c.argument('manifest_name', help='The manifest file name. If not provided, the service will generate one automatically.') 395 c.argument('description', help='The live output description.') 396 c.argument('fragments_per_ts_segment', help='The number of fragments per HLS segment.') 397 c.argument('output_snap_time', help='The output snapshot time.') 398 399 with self.argument_context('ams account-filter') as c: 400 c.argument('account_name', account_name_arg_type) 401 c.argument('filter_name', name_arg_type, id_part='child_name_1', help='The name of the account filter.') 402 c.argument('start_timestamp', arg_group='Presentation Time Range', 403 help='Applies to Video on Demand (VoD) or Live Streaming. This is a long value that represents an absolute start point of the stream. The value gets rounded to the closest next GOP start. The unit is the timescale, so a startTimestamp of 150000000 would be for 15 seconds. Use startTimestamp and endTimestampp to trim the fragments that will be in the playlist (manifest). For example, startTimestamp=40000000 and endTimestamp=100000000 using the default timescale will generate a playlist that contains fragments from between 4 seconds and 10 seconds of the VoD presentation. If a fragment straddles the boundary, the entire fragment will be included in the manifest.') 404 c.argument('end_timestamp', arg_group='Presentation Time Range', 405 help='Applies to Video on Demand (VoD). For the Live Streaming presentation, it is silently ignored and applied when the presentation ends and the stream becomes VoD. This is a long value that represents an absolute end point of the presentation, rounded to the closest next GOP start. The unit is the timescale, so an endTimestamp of 1800000000 would be for 3 minutes. Use startTimestamp and endTimestamp to trim the fragments that will be in the playlist (manifest). For example, startTimestamp=40000000 and endTimestamp=100000000 using the default timescale will generate a playlist that contains fragments from between 4 seconds and 10 seconds of the VoD presentation. If a fragment straddles the boundary, the entire fragment will be included in the manifest.') 406 c.argument('presentation_window_duration', arg_group='Presentation Time Range', 407 help='Applies to Live Streaming only. Use presentationWindowDuration to apply a sliding window of fragments to include in a playlist. The unit for this property is timescale (see below). For example, set presentationWindowDuration=1200000000 to apply a two-minute sliding window. Media within 2 minutes of the live edge will be included in the playlist. If a fragment straddles the boundary, the entire fragment will be included in the playlist. The minimum presentation window duration is 60 seconds.') 408 c.argument('live_backoff_duration', arg_group='Presentation Time Range', 409 help='Applies to Live Streaming only. This value defines the latest live position that a client can seek to. Using this property, you can delay live playback position and create a server-side buffer for players. The unit for this property is timescale (see below). The maximum live back off duration is 300 seconds (3000000000). For example, a value of 2000000000 means that the latest available content is 20 seconds delayed from the real live edge.') 410 c.argument('timescale', arg_group='Presentation Time Range', 411 help='Applies to all timestamps and durations in a Presentation Time Range, specified as the number of increments in one second. Default is 10000000 - ten million increments in one second, where each increment would be 100 nanoseconds long. For example, if you want to set a startTimestamp at 30 seconds, you would use a value of 300000000 when using the default timescale.') 412 c.argument('force_end_timestamp', arg_group='Presentation Time Range', arg_type=get_three_state_flag(), 413 help='Applies to Live Streaming only. Indicates whether the endTimestamp property must be present. If true, endTimestamp must be specified or a bad request code is returned. Allowed values: false, true.') 414 c.argument('bitrate', help='The first quality bitrate.', deprecate_info=c.deprecate(target='--bitrate', redirect='--first-quality', hide=True)) 415 c.argument('first_quality', help='The first quality (lowest) bitrate to include in the manifest.') 416 c.argument('tracks', help='The JSON representing the track selections. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/accountfilters/createorupdate#filtertrackselection') 417 418 with self.argument_context('ams account-filter list') as c: 419 c.argument('account_name', id_part=None) 420