Microsoft.Media videoAnalyzers/accessPolicies 2021-05-01-preview
Bicep resource definition
The videoAnalyzers/accessPolicies resource type can be deployed to:
- 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-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
authentication: {
@type: 'string'
// For remaining properties, see AuthenticationBase objects
}
role: 'Reader'
}
}
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
videoAnalyzers/accessPolicies
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
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 |
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 the object type | #Microsoft.VideoAnalyzer.JwtAuthentication (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[] |
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 |
|---|---|---|
| kid | JWT token key id. Validation keys are looked up based on the key id present on the JWT token header. | string (required) |
| @type | Set the object type | #Microsoft.VideoAnalyzer.EccTokenKey #Microsoft.VideoAnalyzer.RsaTokenKey (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) |
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) |
ARM template resource definition
The videoAnalyzers/accessPolicies resource type can be deployed to:
- 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-05-01-preview",
"name": "string",
"properties": {
"authentication": {
"@type": "string"
// For remaining properties, see AuthenticationBase objects
},
"role": "Reader"
}
}
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
videoAnalyzers/accessPolicies
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Media/videoAnalyzers/accessPolicies' |
| apiVersion | The resource api version | '2021-05-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | The resource properties. | AccessPolicyProperties |
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 the object type | #Microsoft.VideoAnalyzer.JwtAuthentication (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[] |
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 |
|---|---|---|
| kid | JWT token key id. Validation keys are looked up based on the key id present on the JWT token header. | string (required) |
| @type | Set the object type | #Microsoft.VideoAnalyzer.EccTokenKey #Microsoft.VideoAnalyzer.RsaTokenKey (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) |
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) |
Terraform (AzAPI provider) resource definition
The videoAnalyzers/accessPolicies resource type can be deployed to:
- 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-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
authentication = {
@type = "string"
// For remaining properties, see AuthenticationBase objects
}
role = "Reader"
}
})
}
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
videoAnalyzers/accessPolicies
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Media/videoAnalyzers/accessPolicies@2021-05-01-preview" |
| 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 |
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 the object type | #Microsoft.VideoAnalyzer.JwtAuthentication (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[] |
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 |
|---|---|---|
| kid | JWT token key id. Validation keys are looked up based on the key id present on the JWT token header. | string (required) |
| @type | Set the object type | #Microsoft.VideoAnalyzer.EccTokenKey #Microsoft.VideoAnalyzer.RsaTokenKey (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) |
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) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for