Partilhar via


Microsoft.EventGrid namespaces/clients 2023-06-01-preview

Definição de recurso do Bicep

O tipo de recurso de espaços de nomes/clientes pode ser implementado com operações que visam:

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/namespaces/clients, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.EventGrid/namespaces/clients@2023-06-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    attributes: {
      {customized property}: any()
    }
    authentication: {
      certificateSubject: {
        commonName: 'string'
        countryCode: 'string'
        organization: 'string'
        organizationUnit: 'string'
      }
      certificateThumbprint: {
        primary: 'string'
        secondary: 'string'
      }
    }
    authenticationName: 'string'
    clientCertificateAuthentication: {
      allowedThumbprints: [
        'string'
      ]
      validationScheme: 'string'
    }
    description: 'string'
    state: 'string'
  }
}

Valores de propriedade

espaços de nomes/clientes

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados no Bicep.
cadeia (obrigatório)
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só tem de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.
Nome simbólico para recurso do tipo: espaços de nomes
propriedades As propriedades do cliente. Propriedades de Cliente

Propriedades de Cliente

Nome Descrição Valor
atributos Atributos para o cliente. Os valores suportados são int, bool, string, string[].
Exemplo:
"attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }
ClientPropertiesAttributes
autenticação Informações de autenticação do cliente. ClientAuthentication
authenticationName O nome apresentado pelo cliente para autenticação. O valor predefinido é o nome do recurso. string
clientCertificateAuthentication As informações de autenticação do certificado de cliente. ClientCertificateAuthentication
descrição Descrição do recurso Cliente. string
state Indica se o cliente está ativado ou não. O valor predefinido é Ativado. "Desativado"
"Ativado"

ClientPropertiesAttributes

Nome Descrição Valor
{customized property} Para Bicep, pode utilizar a função any( ).

ClientAuthentication

Nome Descrição Valor
certificateSubject O nome do requerente do certificado de AC utilizado para autenticação. ClientCertificateSubjectDistinguishedName
certificateThumbprint Os thumbprints do certificado autoassinado são utilizados para autenticação. ClientCertificateThumbprint

ClientCertificateSubjectDistinguishedName

Nome Descrição Valor
commonName O campo de nome comum no nome do requerente. O limite permitido é de 64 carateres e deve ser especificado. string

Restrições:
Comprimento máximo = 64
countryCode O campo de código do país no nome do requerente. Se estiver presente, o código de país deve ser representado por código de duas letras definido na ISO 2166-1 (alfa-2). Por exemplo: "E.U.A.". string

Restrições:
Comprimento mínimo = 2
Comprimento máximo = 2
organização O campo da organização no nome do requerente. Se estiver presente, o limite permitido é de 64 carateres. string

Restrições:
Comprimento máximo = 64
organizationUnit O campo da unidade da organização no nome do requerente. Se estiver presente, o limite permitido é de 32 carateres. string

Restrições:
Comprimento máximo = 32

ClientCertificateThumbprint

Nome Descrição Valor
principal O thumbprint principal utilizado para validação. string
secundário O thumbprint secundário utilizado para validação. string

ClientCertificateAuthentication

Nome Descrição Valor
allowedThumbprints A lista de thumbprints permitidos durante a autenticação de cliente. Esta propriedade só é necessária se validationScheme for "ThumbprintMatch". string[]
validationScheme O esquema de validação utilizado para autenticar o cliente. O valor predefinido é SubjectMatchesAuthenticationName. "DnsMatchesAuthenticationName"
"EmailMatchesAuthenticationName"
"IpMatchesAuthenticationName"
"SubjectMatchesAuthenticationName"
"ThumbprintMatch"
"UriMatchesAuthenticationName"

Definição de recurso do modelo arm

O tipo de recurso de espaços de nomes/clientes pode ser implementado com operações que visam:

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/namespaces/clients, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.EventGrid/namespaces/clients",
  "apiVersion": "2023-06-01-preview",
  "name": "string",
  "properties": {
    "attributes": {
      "{customized property}": {}
    },
    "authentication": {
      "certificateSubject": {
        "commonName": "string",
        "countryCode": "string",
        "organization": "string",
        "organizationUnit": "string"
      },
      "certificateThumbprint": {
        "primary": "string",
        "secondary": "string"
      }
    },
    "authenticationName": "string",
    "clientCertificateAuthentication": {
      "allowedThumbprints": [ "string" ],
      "validationScheme": "string"
    },
    "description": "string",
    "state": "string"
  }
}

Valores de propriedade

espaços de nomes/clientes

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.EventGrid/namespaces/clients"
apiVersion A versão da API de recursos '2023-06-01-preview'
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos arm JSON.
cadeia (obrigatório)
propriedades As propriedades do cliente. Propriedades de Cliente

Propriedades de Cliente

Nome Descrição Valor
atributos Atributos para o cliente. Os valores suportados são int, bool, string, string[].
Exemplo:
"attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }
ClientPropertiesAttributes
autenticação Informações de autenticação do cliente. ClientAuthentication
authenticationName O nome apresentado pelo cliente para autenticação. O valor predefinido é o nome do recurso. string
clientCertificateAuthentication As informações de autenticação do certificado de cliente. ClientCertificateAuthentication
descrição Descrição do recurso Cliente. string
state Indica se o cliente está ativado ou não. O valor predefinido é Ativado. "Desativado"
"Ativado"

ClientPropertiesAttributes

Nome Descrição Valor
{customized property}

ClientAuthentication

Nome Descrição Valor
certificateSubject O nome do requerente do certificado de AC utilizado para autenticação. ClientCertificateSubjectDistinguishedName
certificateThumbprint Os thumbprints do certificado autoassinado são utilizados para autenticação. ClientCertificateThumbprint

ClientCertificateSubjectDistinguishedName

Nome Descrição Valor
commonName O campo de nome comum no nome do requerente. O limite permitido é de 64 carateres e deve ser especificado. string

Restrições:
Comprimento máximo = 64
countryCode O campo de código do país no nome do requerente. Se estiver presente, o código de país deve ser representado por código de duas letras definido na ISO 2166-1 (alfa-2). Por exemplo: "E.U.A.". string

Restrições:
Comprimento mínimo = 2
Comprimento máximo = 2
organização O campo da organização no nome do requerente. Se estiver presente, o limite permitido é de 64 carateres. string

Restrições:
Comprimento máximo = 64
organizationUnit O campo da unidade da organização no nome do requerente. Se estiver presente, o limite permitido é de 32 carateres. string

Restrições:
Comprimento máximo = 32

ClientCertificateThumbprint

Nome Descrição Valor
principal O thumbprint principal utilizado para validação. string
secundário O thumbprint secundário utilizado para validação. string

ClientCertificateAuthentication

Nome Descrição Valor
allowedThumbprints A lista de thumbprints permitidos durante a autenticação de cliente. Esta propriedade só é necessária se validationScheme for "ThumbprintMatch". string[]
validationScheme O esquema de validação utilizado para autenticar o cliente. O valor predefinido é SubjectMatchesAuthenticationName. "DnsMatchesAuthenticationName"
"EmailMatchesAuthenticationName"
"IpMatchesAuthenticationName"
"SubjectMatchesAuthenticationName"
"ThumbprintMatch"
"UriMatchesAuthenticationName"

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso de espaços de nomes/clientes pode ser implementado com operações que visam:

  • Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/namespaces/clients, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces/clients@2023-06-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      attributes = {}
      authentication = {
        certificateSubject = {
          commonName = "string"
          countryCode = "string"
          organization = "string"
          organizationUnit = "string"
        }
        certificateThumbprint = {
          primary = "string"
          secondary = "string"
        }
      }
      authenticationName = "string"
      clientCertificateAuthentication = {
        allowedThumbprints = [
          "string"
        ]
        validationScheme = "string"
      }
      description = "string"
      state = "string"
    }
  })
}

Valores de propriedade

espaços de nomes/clientes

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.EventGrid/namespaces/clients@2023-06-01-preview"
name O nome do recurso cadeia (obrigatório)
parent_id O ID do recurso que é o principal para este recurso. ID do recurso do tipo: espaços de nomes
propriedades As propriedades do cliente. Propriedades de Cliente

Propriedades de Cliente

Nome Descrição Valor
atributos Atributos para o cliente. Os valores suportados são int, bool, string, string[].
Exemplo:
"attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }
ClientPropertiesAttributes
autenticação Informações de autenticação do cliente. ClientAuthentication
authenticationName O nome apresentado pelo cliente para autenticação. O valor predefinido é o nome do recurso. string
clientCertificateAuthentication As informações de autenticação do certificado de cliente. ClientCertificateAuthentication
descrição Descrição do recurso Cliente. string
state Indica se o cliente está ativado ou não. O valor predefinido está Ativado. "Desativado"
"Ativado"

ClientPropertiesAttributes

Nome Descrição Valor
{customized property}

ClientAuthentication

Nome Descrição Valor
certificateSubject O nome do requerente do certificado de AC utilizado para autenticação. ClientCertificateSubjectDistinguishedName
certificateThumbprint Os dados de thumbprints do certificado autoassinado utilizados para autenticação. ClientCertificateThumbprint

ClientCertificateSubjectDistinguishedName

Nome Descrição Valor
commonName O campo de nome comum no nome do requerente. O limite permitido é de 64 carateres e deve ser especificado. string

Restrições:
Comprimento máximo = 64
countryCode O campo de código do país no nome do requerente. Se estiver presente, o código de país deve ser representado por código de duas letras definido na ISO 2166-1 (alfa-2). Por exemplo: "E.U.A.". string

Restrições:
Comprimento mínimo = 2
Comprimento máximo = 2
organização O campo da organização no nome do requerente. Se estiver presente, o limite permitido é de 64 carateres. string

Restrições:
Comprimento máximo = 64
organizationUnit O campo da unidade da organização no nome do requerente. Se estiver presente, o limite permitido é de 32 carateres. string

Restrições:
Comprimento máximo = 32

ClientCertificateThumbprint

Nome Descrição Valor
primária O thumbprint principal utilizado para validação. string
secundário O thumbprint secundário utilizado para validação. string

ClientCertificateAuthentication

Nome Descrição Valor
allowedThumbprints A lista de thumbprints permitidos durante a autenticação do cliente. Esta propriedade só é necessária se validationScheme for "ThumbprintMatch". cadeia[]
validationScheme O esquema de validação utilizado para autenticar o cliente. O valor predefinido é SubjectMatchesAuthenticationName. "DnsMatchesAuthenticationName"
"EmailMatchesAuthenticationName"
"IpMatchesAuthenticationName"
"SubjectMatchesAuthenticationName"
"ThumbprintMatch"
"UriMatchesAuthenticationName"