Freigeben über

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

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp namespaces/clients kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.EventGrid/namespaces/clients-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.

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'
  }
}

Eigenschaftswerte

Namespaces/Clients

Name BESCHREIBUNG Wert
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep.		 Zeichenfolge (erforderlich)
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.		 Symbolischer Name für Ressource vom Typ: Namespaces
properties Die Eigenschaften des Clients. ClientEigenschaften

ClientEigenschaften

Name BESCHREIBUNG Wert
attributes Attribute für den Client. Unterstützte Werte sind int, bool, string, string[].
Beispiel:
"attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }		 ClientPropertiesAttributes
authentication Authentifizierungsinformationen für den Client. ClientAuthentication
authenticationName Der Name, der vom Client für die Authentifizierung angegeben wird. Der Standardwert ist der Name der Ressource. Zeichenfolge
clientCertificateAuthentication Die Clientzertifikatauthentifizierungsinformationen. ClientCertificateAuthentication
description Beschreibung für die Clientressource. Zeichenfolge
state Gibt an, ob der Client aktiviert ist. Der Standardwert ist Enabled. "Deaktiviert"
"Aktiviert"

ClientPropertiesAttributes

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Für Bicep können Sie die funktion any() verwenden.

ClientAuthentication

Name BESCHREIBUNG Wert
certificateSubject Der Name des Zertifizierungsstellenzertifikats, der für die Authentifizierung verwendet wird. ClientCertificateSubjectDistinguishedName
certificateThumbprint Die für die Authentifizierung verwendeten Fingerabdruckdaten des selbstsignierten Zertifikats. ClientCertificateThumbprint

ClientCertificateSubjectDistinguishedName

Name BESCHREIBUNG Wert
commonName Das Feld "Allgemeiner Name" im Antragstellernamen. Der zulässige Grenzwert beträgt 64 Zeichen und sollte angegeben werden. Zeichenfolge

Einschränkungen:
Maximale Länge = 64
countryCode Das Ländercodefeld im Antragstellernamen. Falls vorhanden, sollte der Ländercode durch einen in ISO 2166-1 (Alpha-2) definierten zweistelligen Code dargestellt werden. Beispiel: "US". Zeichenfolge

Einschränkungen:
Min. Länge = 2
Maximale Länge = 2
organization Das feld organization im Antragstellernamen. Falls vorhanden, beträgt der zulässige Grenzwert 64 Zeichen. Zeichenfolge

Einschränkungen:
Maximale Länge = 64
organizationUnit Das organization Feld "Einheit" im Antragstellernamen. Falls vorhanden, beträgt der zulässige Grenzwert 32 Zeichen. Zeichenfolge

Einschränkungen:
Maximale Länge = 32

ClientCertificateThumbprint

Name BESCHREIBUNG Wert
primary Der primäre Fingerabdruck, der für die Validierung verwendet wird. Zeichenfolge
repliziert Der sekundäre Fingerabdruck, der für die Validierung verwendet wird. Zeichenfolge

ClientCertificateAuthentication

Name BESCHREIBUNG Wert
allowedThumbprints Die Liste der Fingerabdrucke, die während der Clientauthentifizierung zulässig sind. Diese Eigenschaft ist nur erforderlich, wenn validationScheme "ThumbprintMatch" lautet. string[]
validationScheme Das Validierungsschema, das zum Authentifizieren des Clients verwendet wird. Der Standardwert ist SubjectMatchesAuthenticationName. "DnsMatchesAuthenticationName"
"EmailMatchesAuthenticationName"
"IpMatchesAuthenticationName"
'SubjectMatchesAuthenticationName'
"ThumbprintMatch"
'UriMatchesAuthenticationName'

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp namespaces/clients kann mit Vorgängen bereitgestellt werden, die folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.EventGrid/namespaces/clients-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.

{
  "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"
  }
}

Eigenschaftswerte

Namespaces/Clients

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.EventGrid/namespaces/clients"
apiVersion Die Ressourcen-API-Version '2023-06-01-preview'
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.		 Zeichenfolge (erforderlich)
properties Die Eigenschaften des Clients. ClientEigenschaften

ClientEigenschaften

Name BESCHREIBUNG Wert
attributes Attribute für den Client. Unterstützte Werte sind int, bool, string, string[].
Beispiel:
"attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }		 ClientPropertiesAttributes
authentication Authentifizierungsinformationen für den Client. ClientAuthentication
authenticationName Der vom Client für die Authentifizierung angegebene Name. Der Standardwert ist der Name der Ressource. Zeichenfolge
clientCertificateAuthentication Die Clientzertifikatauthentifizierungsinformationen. ClientCertificateAuthentication
description Beschreibung für die Clientressource. Zeichenfolge
state Gibt an, ob der Client aktiviert ist oder nicht. Der Standardwert ist Aktiviert. "Deaktiviert"
"Aktiviert"

ClientPropertiesAttributes

Name BESCHREIBUNG Wert
{angepasste Eigenschaft}

ClientAuthentication

Name BESCHREIBUNG Wert
certificateSubject Der Für die Authentifizierung verwendete Antragstellername des Zertifizierungsstellenzertifikats. ClientCertificateSubjectDistinguishedName
certificateThumbprint Die Fingerabdruckdaten des selbstsignierten Zertifikats, die für die Authentifizierung verwendet werden. ClientCertificateThumbprint

ClientCertificateSubjectDistinguishedName

Name BESCHREIBUNG Wert
commonName Das Feld allgemeiner Name im Antragstellernamen. Der zulässige Grenzwert beträgt 64 Zeichen und sollte angegeben werden. Zeichenfolge

Einschränkungen:
Maximale Länge = 64
countryCode Das Ländercodefeld im Antragstellernamen. Falls vorhanden, sollte der Ländercode durch zwei Buchstaben dargestellt werden, der in ISO 2166-1 (alpha-2) definiert ist. Beispiel: "US". Zeichenfolge

Einschränkungen:
Min. Länge = 2
Maximale Länge = 2
organization Das organization Feld im Antragstellernamen. Falls vorhanden, beträgt der zulässige Grenzwert 64 Zeichen. Zeichenfolge

Einschränkungen:
Maximale Länge = 64
organizationUnit Das organization Feld der Einheit im Antragstellernamen. Falls vorhanden, beträgt der zulässige Grenzwert 32 Zeichen. Zeichenfolge

Einschränkungen:
Maximale Länge = 32

ClientCertificateThumbprint

Name BESCHREIBUNG Wert
primary Der primäre Fingerabdruck, der für die Validierung verwendet wird. Zeichenfolge
repliziert Der sekundäre Fingerabdruck, der für die Validierung verwendet wird. Zeichenfolge

ClientCertificateAuthentication

Name BESCHREIBUNG Wert
allowedThumbprints Die Liste der Fingerabdrucke, die während der Clientauthentifizierung zulässig sind. Diese Eigenschaft ist nur erforderlich, wenn validationScheme "ThumbprintMatch" lautet. string[]
validationScheme Das Validierungsschema, das zum Authentifizieren des Clients verwendet wird. Der Standardwert ist SubjectMatchesAuthenticationName. "DnsMatchesAuthenticationName"
"EmailMatchesAuthenticationName"
"IpMatchesAuthenticationName"
'SubjectMatchesAuthenticationName'
"ThumbprintMatch"
'UriMatchesAuthenticationName'

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp namespaces/clients kann mit Vorgängen bereitgestellt werden, die folgendes zum Ziel haben:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.EventGrid/namespaces/clients-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform-Ressource hinzu.

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"
    }
  })
}

Eigenschaftswerte

Namespaces/Clients

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.EventGrid/namespaces/clients@2023-06-01-preview"
name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. ID für Ressource vom Typ: Namespaces
properties Die Eigenschaften des Clients. ClientEigenschaften

ClientEigenschaften

Name BESCHREIBUNG Wert
attributes Attribute für den Client. Unterstützte Werte sind int, bool, string, string[].
Beispiel:
"attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }		 ClientPropertiesAttributes
authentication Authentifizierungsinformationen für den Client. ClientAuthentication
authenticationName Der vom Client für die Authentifizierung angegebene Name. Der Standardwert ist der Name der Ressource. Zeichenfolge
clientCertificateAuthentication Die Clientzertifikatauthentifizierungsinformationen. ClientCertificateAuthentication
description Beschreibung für die Clientressource. Zeichenfolge
state Gibt an, ob der Client aktiviert ist oder nicht. Der Standardwert ist Aktiviert. "Deaktiviert"
"Aktiviert"

ClientPropertiesAttributes

Name BESCHREIBUNG Wert
{angepasste Eigenschaft}

ClientAuthentication

Name BESCHREIBUNG Wert
certificateSubject Der Für die Authentifizierung verwendete Antragstellername des Zertifizierungsstellenzertifikats. ClientCertificateSubjectDistinguishedName
certificateThumbprint Die Fingerabdruckdaten des selbstsignierten Zertifikats, die für die Authentifizierung verwendet werden. ClientCertificateThumbprint

ClientCertificateSubjectDistinguishedName

Name BESCHREIBUNG Wert
commonName Das Feld allgemeiner Name im Antragstellernamen. Der zulässige Grenzwert beträgt 64 Zeichen und sollte angegeben werden. Zeichenfolge

Einschränkungen:
Maximale Länge = 64
countryCode Das Ländercodefeld im Antragstellernamen. Falls vorhanden, sollte der Ländercode durch zwei Buchstaben dargestellt werden, der in ISO 2166-1 (alpha-2) definiert ist. Beispiel: "US". Zeichenfolge

Einschränkungen:
Min. Länge = 2
Maximale Länge = 2
organization Das organization Feld im Antragstellernamen. Falls vorhanden, beträgt der zulässige Grenzwert 64 Zeichen. Zeichenfolge

Einschränkungen:
Maximale Länge = 64
organizationUnit Das organization Feld der Einheit im Antragstellernamen. Falls vorhanden, beträgt der zulässige Grenzwert 32 Zeichen. Zeichenfolge

Einschränkungen:
Maximale Länge = 32

ClientCertificateThumbprint

Name BESCHREIBUNG Wert
primary Der primäre Fingerabdruck, der für die Validierung verwendet wird. Zeichenfolge
repliziert Der sekundäre Fingerabdruck, der für die Validierung verwendet wird. Zeichenfolge

ClientCertificateAuthentication

Name BESCHREIBUNG Wert
allowedThumbprints Die Liste der Fingerabdrucke, die während der Clientauthentifizierung zulässig sind. Diese Eigenschaft ist nur erforderlich, wenn validationScheme "ThumbprintMatch" lautet. string[]
validationScheme Das Validierungsschema, das zum Authentifizieren des Clients verwendet wird. Der Standardwert ist SubjectMatchesAuthenticationName. "DnsMatchesAuthenticationName"
"EmailMatchesAuthenticationName"
"IpMatchesAuthenticationName"
"SubjectMatchesAuthenticationName"
"ThumbprintMatch"
"UriMatchesAuthenticationName"