Microsoft.Media videoAnalyzers/accessPolicies

• Latest
• 2021-11-01-preview
• 2021-05-01-preview

Bicep resource definition

The videoAnalyzers/accessPolicies resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Media/videoAnalyzers/accessPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Media/videoAnalyzers/accessPolicies@2021-11-01-preview' = {
  name: 'string'
  properties: {
    authentication: {
      @type: 'string'
      // For remaining properties, see AuthenticationBase objects
    }
    role: 'string'
  }
}

AuthenticationBase objects

Set the @type property to specify the type of object.

For #Microsoft.VideoAnalyzer.JwtAuthentication, use:

{
  @type: '#Microsoft.VideoAnalyzer.JwtAuthentication'
  audiences: [
    'string'
  ]
  claims: [
    {
      name: 'string'
      value: 'string'
    }
  ]
  issuers: [
    'string'
  ]
  keys: [
    {
      kid: 'string'
      @type: 'string'
      // For remaining properties, see TokenKey objects
    }
  ]
}

TokenKey objects

Set the @type property to specify the type of object.

For #Microsoft.VideoAnalyzer.EccTokenKey, use:

{
  @type: '#Microsoft.VideoAnalyzer.EccTokenKey'
  alg: 'string'
  x: 'string'
  y: 'string'
}

For #Microsoft.VideoAnalyzer.RsaTokenKey, use:

{
  @type: '#Microsoft.VideoAnalyzer.RsaTokenKey'
  alg: 'string'
  e: 'string'
  n: 'string'
}

Property values

AccessPolicyProperties

Name	Description	Value
authentication	Authentication method to be used when validating client API access.	AuthenticationBase
role	Defines the access level granted by this policy.	'Reader'

AuthenticationBase

Name	Description	Value
@type	Set to '#Microsoft.VideoAnalyzer.JwtAuthentication' for type JwtAuthentication.	'#Microsoft.VideoAnalyzer.JwtAuthentication' (required)

EccTokenKey

Name	Description	Value
@type	The discriminator for derived types.	'#Microsoft.VideoAnalyzer.EccTokenKey' (required)
alg	Elliptical curve algorithm to be used: ES256, ES384 or ES512.	'ES256' 'ES384' 'ES512' (required)
x	X coordinate.	string (required)
y	Y coordinate.	string (required)

JwtAuthentication

Name	Description	Value
@type	The discriminator for derived types.	'#Microsoft.VideoAnalyzer.JwtAuthentication' (required)
audiences	List of expected token audiences. Token audience is valid if it matches at least one of the given values.	string[]
claims	List of additional token claims to be validated. Token must contains all claims and respective values for it to be valid.	TokenClaim[]
issuers	List of expected token issuers. Token issuer is valid if it matches at least one of the given values.	string[]
keys	List of keys which can be used to validate access tokens. Having multiple keys allow for seamless key rotation of the token signing key. Token signature must match exactly one key.	TokenKey[]

Microsoft.Media/videoAnalyzers/accessPolicies

Name	Description	Value
name	The resource name	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: videoAnalyzers
properties	The resource properties.	AccessPolicyProperties

RsaTokenKey

Name	Description	Value
@type	The discriminator for derived types.	'#Microsoft.VideoAnalyzer.RsaTokenKey' (required)
alg	RSA algorithm to be used: RS256, RS384 or RS512.	'RS256' 'RS384' 'RS512' (required)
e	RSA public key exponent.	string (required)
n	RSA public key modulus.	string (required)

TokenClaim

Name	Description	Value
name	Name of the claim which must be present on the token.	string (required)
value	Expected value of the claim to be present on the token.	string (required)

TokenKey

Name	Description	Value
@type	Set to '#Microsoft.VideoAnalyzer.EccTokenKey' for type EccTokenKey. Set to '#Microsoft.VideoAnalyzer.RsaTokenKey' for type RsaTokenKey.	'#Microsoft.VideoAnalyzer.EccTokenKey' '#Microsoft.VideoAnalyzer.RsaTokenKey' (required)
kid	JWT token key id. Validation keys are looked up based on the key id present on the JWT token header.	string (required)

ARM template resource definition

The videoAnalyzers/accessPolicies resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Media/videoAnalyzers/accessPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.Media/videoAnalyzers/accessPolicies",
  "apiVersion": "2021-11-01-preview",
  "name": "string",
  "properties": {
    "authentication": {
      "@type": "string"
      // For remaining properties, see AuthenticationBase objects
    },
    "role": "string"
  }
}

AuthenticationBase objects

Set the @type property to specify the type of object.

For #Microsoft.VideoAnalyzer.JwtAuthentication, use:

{
  "@type": "#Microsoft.VideoAnalyzer.JwtAuthentication",
  "audiences": [ "string" ],
  "claims": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "issuers": [ "string" ],
  "keys": [ {
    "kid": "string",
    "@type": "string"
    // For remaining properties, see TokenKey objects
  } ]
}

TokenKey objects

Set the @type property to specify the type of object.

For #Microsoft.VideoAnalyzer.EccTokenKey, use:

{
  "@type": "#Microsoft.VideoAnalyzer.EccTokenKey",
  "alg": "string",
  "x": "string",
  "y": "string"
}

For #Microsoft.VideoAnalyzer.RsaTokenKey, use:

{
  "@type": "#Microsoft.VideoAnalyzer.RsaTokenKey",
  "alg": "string",
  "e": "string",
  "n": "string"
}

Property values

AccessPolicyProperties

Name	Description	Value
authentication	Authentication method to be used when validating client API access.	AuthenticationBase
role	Defines the access level granted by this policy.	'Reader'

AuthenticationBase

Name	Description	Value
@type	Set to '#Microsoft.VideoAnalyzer.JwtAuthentication' for type JwtAuthentication.	'#Microsoft.VideoAnalyzer.JwtAuthentication' (required)

EccTokenKey

Name	Description	Value
@type	The discriminator for derived types.	'#Microsoft.VideoAnalyzer.EccTokenKey' (required)
alg	Elliptical curve algorithm to be used: ES256, ES384 or ES512.	'ES256' 'ES384' 'ES512' (required)
x	X coordinate.	string (required)
y	Y coordinate.	string (required)

JwtAuthentication

Name	Description	Value
@type	The discriminator for derived types.	'#Microsoft.VideoAnalyzer.JwtAuthentication' (required)
audiences	List of expected token audiences. Token audience is valid if it matches at least one of the given values.	string[]
claims	List of additional token claims to be validated. Token must contains all claims and respective values for it to be valid.	TokenClaim[]
issuers	List of expected token issuers. Token issuer is valid if it matches at least one of the given values.	string[]
keys	List of keys which can be used to validate access tokens. Having multiple keys allow for seamless key rotation of the token signing key. Token signature must match exactly one key.	TokenKey[]

Microsoft.Media/videoAnalyzers/accessPolicies

Name	Description	Value
apiVersion	The api version	'2021-11-01-preview'
name	The resource name	string (required)
properties	The resource properties.	AccessPolicyProperties
type	The resource type	'Microsoft.Media/videoAnalyzers/accessPolicies'

RsaTokenKey

Name	Description	Value
@type	The discriminator for derived types.	'#Microsoft.VideoAnalyzer.RsaTokenKey' (required)
alg	RSA algorithm to be used: RS256, RS384 or RS512.	'RS256' 'RS384' 'RS512' (required)
e	RSA public key exponent.	string (required)
n	RSA public key modulus.	string (required)

TokenClaim

Name	Description	Value
name	Name of the claim which must be present on the token.	string (required)
value	Expected value of the claim to be present on the token.	string (required)

TokenKey

Name	Description	Value
@type	Set to '#Microsoft.VideoAnalyzer.EccTokenKey' for type EccTokenKey. Set to '#Microsoft.VideoAnalyzer.RsaTokenKey' for type RsaTokenKey.	'#Microsoft.VideoAnalyzer.EccTokenKey' '#Microsoft.VideoAnalyzer.RsaTokenKey' (required)
kid	JWT token key id. Validation keys are looked up based on the key id present on the JWT token header.	string (required)

Terraform (AzAPI provider) resource definition

The videoAnalyzers/accessPolicies resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Media/videoAnalyzers/accessPolicies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Media/videoAnalyzers/accessPolicies@2021-11-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      authentication = {
        @type = "string"
        // For remaining properties, see AuthenticationBase objects
      }
      role = "string"
    }
  })
}

AuthenticationBase objects

Set the @type property to specify the type of object.

For #Microsoft.VideoAnalyzer.JwtAuthentication, use:

{
  @type = "#Microsoft.VideoAnalyzer.JwtAuthentication"
  audiences = [
    "string"
  ]
  claims = [
    {
      name = "string"
      value = "string"
    }
  ]
  issuers = [
    "string"
  ]
  keys = [
    {
      kid = "string"
      @type = "string"
      // For remaining properties, see TokenKey objects
    }
  ]
}

TokenKey objects

Set the @type property to specify the type of object.

For #Microsoft.VideoAnalyzer.EccTokenKey, use:

{
  @type = "#Microsoft.VideoAnalyzer.EccTokenKey"
  alg = "string"
  x = "string"
  y = "string"
}

For #Microsoft.VideoAnalyzer.RsaTokenKey, use:

{
  @type = "#Microsoft.VideoAnalyzer.RsaTokenKey"
  alg = "string"
  e = "string"
  n = "string"
}

Property values

AccessPolicyProperties

Name	Description	Value
authentication	Authentication method to be used when validating client API access.	AuthenticationBase
role	Defines the access level granted by this policy.	'Reader'

AuthenticationBase

Name	Description	Value
@type	Set to '#Microsoft.VideoAnalyzer.JwtAuthentication' for type JwtAuthentication.	'#Microsoft.VideoAnalyzer.JwtAuthentication' (required)

EccTokenKey

Name	Description	Value
@type	The discriminator for derived types.	'#Microsoft.VideoAnalyzer.EccTokenKey' (required)
alg	Elliptical curve algorithm to be used: ES256, ES384 or ES512.	'ES256' 'ES384' 'ES512' (required)
x	X coordinate.	string (required)
y	Y coordinate.	string (required)

JwtAuthentication

Name	Description	Value
@type	The discriminator for derived types.	'#Microsoft.VideoAnalyzer.JwtAuthentication' (required)
audiences	List of expected token audiences. Token audience is valid if it matches at least one of the given values.	string[]
claims	List of additional token claims to be validated. Token must contains all claims and respective values for it to be valid.	TokenClaim[]
issuers	List of expected token issuers. Token issuer is valid if it matches at least one of the given values.	string[]
keys	List of keys which can be used to validate access tokens. Having multiple keys allow for seamless key rotation of the token signing key. Token signature must match exactly one key.	TokenKey[]

Microsoft.Media/videoAnalyzers/accessPolicies

Name	Description	Value
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: videoAnalyzers
properties	The resource properties.	AccessPolicyProperties
type	The resource type	"Microsoft.Media/videoAnalyzers/accessPolicies@2021-11-01-preview"

RsaTokenKey

Name	Description	Value
@type	The discriminator for derived types.	'#Microsoft.VideoAnalyzer.RsaTokenKey' (required)
alg	RSA algorithm to be used: RS256, RS384 or RS512.	'RS256' 'RS384' 'RS512' (required)
e	RSA public key exponent.	string (required)
n	RSA public key modulus.	string (required)

TokenClaim

Name	Description	Value
name	Name of the claim which must be present on the token.	string (required)
value	Expected value of the claim to be present on the token.	string (required)

TokenKey

Name	Description	Value
@type	Set to '#Microsoft.VideoAnalyzer.EccTokenKey' for type EccTokenKey. Set to '#Microsoft.VideoAnalyzer.RsaTokenKey' for type RsaTokenKey.	'#Microsoft.VideoAnalyzer.EccTokenKey' '#Microsoft.VideoAnalyzer.RsaTokenKey' (required)
kid	JWT token key id. Validation keys are looked up based on the key id present on the JWT token header.	string (required)