次の方法で共有


Microsoft.EventGrid 名前空間 2024-06-01-preview

Bicep リソース定義

名前空間のリソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.EventGrid/namespaces リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.EventGrid/namespaces@2024-06-01-preview' = {
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    inboundIpRules: [
      {
        action: 'string'
        ipMask: 'string'
      }
    ]
    isZoneRedundant: bool
    minimumTlsVersionAllowed: 'string'
    privateEndpointConnections: [
      {
        properties: {
          groupIds: [
            'string'
          ]
          privateEndpoint: {
            id: 'string'
          }
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
          provisioningState: 'string'
        }
      }
    ]
    publicNetworkAccess: 'string'
    topicsConfiguration: {
      customDomains: [
        {
          certificateUrl: 'string'
          expectedTxtRecordName: 'string'
          expectedTxtRecordValue: 'string'
          fullyQualifiedDomainName: 'string'
          identity: {
            type: 'string'
            userAssignedIdentity: 'string'
          }
          validationState: 'string'
        }
      ]
    }
    topicSpacesConfiguration: {
      clientAuthentication: {
        alternativeAuthenticationNameSources: [
          'string'
        ]
        customJwtAuthentication: {
          issuerCertificates: [
            {
              certificateUrl: 'string'
              identity: {
                type: 'string'
                userAssignedIdentity: 'string'
              }
            }
          ]
          tokenIssuer: 'string'
        }
      }
      customDomains: [
        {
          certificateUrl: 'string'
          expectedTxtRecordName: 'string'
          expectedTxtRecordValue: 'string'
          fullyQualifiedDomainName: 'string'
          identity: {
            type: 'string'
            userAssignedIdentity: 'string'
          }
          validationState: 'string'
        }
      ]
      maximumClientSessionsPerAuthenticationName: int
      maximumSessionExpiryInHours: int
      routeTopicResourceId: 'string'
      routingEnrichments: {
        dynamic: [
          {
            key: 'string'
            value: 'string'
          }
        ]
        static: [
          {
            key: 'string'
            valueType: 'string'
            // For remaining properties, see StaticRoutingEnrichment objects
          }
        ]
      }
      routingIdentityInfo: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
      state: 'string'
    }
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

StaticRoutingEnrichment オブジェクト

valueType プロパティを設定して、オブジェクトの種類を指定します。

文字列 の場合は、次の値を使用します。

{
  value: 'string'
  valueType: 'String'
}

プロパティ値

ClientAuthenticationSettings

名前 形容 価値
alternativeAuthenticationNameSources 名前空間リソースのクライアント認証設定に関連する代替認証名ソース。 次のいずれかを含む文字列配列:
'ClientCertificateDns'
'ClientCertificateEmail'
'ClientCertificateIp'
'ClientCertificateSubject'
'ClientCertificateUri'
customJwtAuthentication 名前空間リソースのカスタム JWT 認証設定。 CustomJwtAuthenticationSettings の

ConnectionState

名前 形容 価値
actionsRequired 必要なアクション (ある場合)。
形容 接続状態の説明。
地位 接続の状態。 'Approved'
'Disconnected'
'Pending'
'Rejected'

CustomDomainConfiguration

名前 形容 価値
certificateUrl カスタム ドメインへの発行に使用される証明書の URL。 現在、Azure Key Vault にのみ格納されている証明書がサポートされています。 証明書の URL は次のいずれかになります。
次の形式のバージョン管理された URL https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}、または次の形式のバージョン管理されていない URL (例:
https://contosovault.vault.azure.net/certificates/contosocert、バージョン管理されていない証明書 URL のみがサポートされます (例: https://contosovault.vault.azure.net/certificates/contosocert)
expectedTxtRecordName DNS TXT レコード名が必要です。 Event Grid では、カスタム ドメイン名の DNS レコード セットでこの名前の TXT レコードがチェックされ、ドメインの所有権が証明されます。
この TXT レコードの値には、予想される TXT レコード値が含まれている必要があります。
expectedTxtRecordValue DNS TXT レコード値が必要です。 Event Grid では、カスタム ドメイン名の DNS レコード セットでこの値を持つ TXT レコードがチェックされ、ドメインの所有権が証明されます。
fullyQualifiedDomainName カスタム ドメインの完全修飾ドメイン名 (FQDN)。 string (必須)
同一性 カスタム ドメインの証明書にアクセスするための ID 情報。 この ID 情報は、名前空間に設定されている ID と一致する必要があります。 CustomDomainIdentity の
validationState カスタム ドメインの検証状態。 これは読み取り専用プロパティであり、最初は "保留中" に設定され、ドメイン名の所有権が正常に検証された後にのみ、Event Grid によって "承認済み" に更新されます。 'Approved'
'ErrorRetrievingDnsRecord'
'Pending'

CustomDomainIdentity

名前 形容 価値
種類 使用されるマネージド ID の種類。 'SystemAssigned' または 'UserAssigned' のいずれかを指定できます。 'SystemAssigned'
'UserAssigned'
userAssignedIdentity リソースに関連付けられているユーザー ID。

CustomJwtAuthenticationManagedIdentity

名前 形容 価値
種類 使用されるマネージド ID の種類。 'SystemAssigned' または 'UserAssigned' のいずれかを指定できます。 'SystemAssigned'
'UserAssigned' (必須)
userAssignedIdentity リソースに関連付けられているユーザー ID。

CustomJwtAuthenticationSettings

名前 形容 価値
issuerCertificates トークンの検証に使用される証明書に関する情報。 現在、最大 2 つの証明書がサポートされています。 IssuerCertificateInfo[]
tokenIssuer JWT トークン発行者が必要です。

DynamicRoutingEnrichment

名前 形容 価値
動的ルーティング エンリッチメント キー。
価値 動的ルーティング エンリッチメント値。

IdentityInfo

名前 形容 価値
principalId リソース ID のプリンシパル ID。
tenantId リソースのテナント ID。
種類 使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
現在、このプロパティは使用されず、将来使用するために予約されています。
IdentityInfoUserAssignedIdentities の

IdentityInfoUserAssignedIdentities

名前 形容 価値

InboundIpRule

名前 形容 価値
アクション IpMask の一致または一致に基づいて実行するアクション。 'Allow'
ipMask CIDR 表記の IP アドレス (例: 10.0.0.0/8)。

IssuerCertificateInfo

名前 形容 価値
certificateUrl https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion 形式の Keyvault 証明書 URL。 string (必須)
同一性 証明書へのアクセスに使用される ID。 CustomJwtAuthenticationManagedIdentity の

Microsoft.EventGrid/namespaces

名前 形容 価値
同一性 名前空間リソースの ID 情報。 IdentityInfo の
場所 リソースの場所。 string (必須)
名前 リソース名

制約:
最小長 = 3
最大長 = 3
パターン = ^[a-zA-Z0-9-]*$ (必須)
プロパティ 名前空間リソースのプロパティ。 NamespaceProperties の
sku 使用可能な SKU 価格レベルを表します。 NamespaceSku
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

NamespaceProperties

名前 形容 価値
inboundIpRules これは、すべての IP ではなく、特定の IP からのトラフィックを制限するために使用できます。 注: これらは、PublicNetworkAccess が有効になっている場合にのみ考慮されます。 InboundIpRule[]
isZoneRedundant これは省略可能なプロパティであり、名前空間リソースがゾーン冗長機能をサポートしているかどうかをユーザーが指定できます。 この場合
プロパティがユーザーによって明示的に指定されていない場合、既定値は次の条件によって異なります。
ある。 Availability Zones が有効なリージョンの場合- 既定のプロパティ値は true になります。
b. 可用性ゾーンが有効になっていないリージョンの場合- 既定のプロパティ値は false になります。
一度指定すると、このプロパティを更新できません。
bool
minimumTlsVersionAllowed この名前空間への発行が許可されているパブリッシャーの最小 TLS バージョン。 TLS バージョン 1.2 のみがサポートされています。 '1.0'
'1.1'
'1.2'
privateEndpointConnections プライベート エンドポイント接続の一覧。 PrivateEndpointConnection[]
publicNetworkAccess これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。
seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" / <構成することで、特定の IP をさらに制限できます>
'Disabled'
'Enabled'
'SecuredByPerimeter'
topicsConfiguration 名前空間リソースのトピック構成情報 TopicsConfiguration
topicSpacesConfiguration 名前空間リソースのトピック・スペース構成情報 TopicSpacesConfiguration

NamespaceSku

名前 形容 価値
能力 名前空間の容量を定義するスループット ユニットの数を指定します。 プロパティの既定値は次の値です。
1 は、名前空間あたり 1 スループット ユニット = 1 MB/秒のイングレスと 2 MB/秒のエグレスを意味します。 最小容量は 1 で、
最大許容容量は 20 です。
int
名前 SKU の名前。 'Standard'

PrivateEndpoint

名前 形容 価値
身分証明書 プライベート エンドポイントの ARM 識別子。

PrivateEndpointConnection

名前 形容 価値
プロパティ PrivateEndpointConnection のプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 形容 価値
groupIds プライベート リンク サービス リソースの GroupId。 string[]
privateEndpoint この接続のプライベート エンドポイント リソース。 PrivateEndpoint を する
privateLinkServiceConnectionState 接続の状態に関する詳細。 ConnectionState
provisioningState プライベート エンドポイント接続のプロビジョニング状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'

RoutingEnrichments

名前 形容 価値
動的 DynamicRoutingEnrichment[]
静的 StaticRoutingEnrichment[]

RoutingIdentityInfo

名前 形容 価値
種類 トピック・スペース構成のルーティング ID タイプ。 'None'
'SystemAssigned'
'UserAssigned'
userAssignedIdentity

StaticRoutingEnrichment

名前 形容 価値
静的ルーティング エンリッチメント キー。
valueType StaticStringRoutingEnrichmentの型 'String' に設定します。 'String' (必須)

StaticStringRoutingEnrichment

名前 形容 価値
価値 文字列型ルーティング エンリッチメント値。
valueType 静的ルーティング エンリッチメント値の種類。 たとえば、このプロパティ値には "String" を指定できます。 'String' (必須)

TopicsConfiguration

名前 形容 価値
customDomains 名前空間のカスタム ドメイン構成の一覧。 CustomDomainConfiguration[]

TopicSpacesConfiguration

名前 形容 価値
clientAuthentication トピック・スペース構成のクライアント認証設定。 ClientAuthenticationSettings
customDomains 名前空間のカスタム ドメイン構成の一覧。 CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName 認証名あたりのセッションの最大数。 プロパティの既定値は 1 です。
最小許容値は 1、最大許容値は 100 です。
int
maximumSessionExpiryInHours セッションの最大有効期限 (時間単位)。 プロパティの既定値は 1 時間です。
最小値は 1 時間で、最大許容値は 8 時間です。
int
routeTopicResourceId 名前空間の下の TopicSpaces からイベントのルーティング先となる Event Grid トピックの完全修飾 Azure リソース ID。
このプロパティは、'/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft の形式にする必要があります。EventGrid/topics/{topicName}'。
このトピックは、名前空間が配置されているのと同じリージョンに存在する必要があります。
routingEnrichments トピック・スペース構成のルーティング・エンリッチメント RoutingEnrichments
routingIdentityInfo トピック・スペース構成のルーティング ID 情報。 RoutingIdentityInfo の
状態 名前空間に対してトピック スペースの構成が有効になっているかどうかを示します。 既定値は [無効] です。 'Disabled'
'Enabled'

TrackedResourceTags

名前 形容 価値

UserIdentityProperties

名前 形容 価値
clientId ユーザー割り当て ID のクライアント ID。
principalId ユーザー割り当て ID のプリンシパル ID。

ARM テンプレート リソース定義

名前空間のリソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.EventGrid/namespaces リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.EventGrid/namespaces",
  "apiVersion": "2024-06-01-preview",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "inboundIpRules": [
      {
        "action": "string",
        "ipMask": "string"
      }
    ],
    "isZoneRedundant": "bool",
    "minimumTlsVersionAllowed": "string",
    "privateEndpointConnections": [
      {
        "properties": {
          "groupIds": [ "string" ],
          "privateEndpoint": {
            "id": "string"
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          },
          "provisioningState": "string"
        }
      }
    ],
    "publicNetworkAccess": "string",
    "topicsConfiguration": {
      "customDomains": [
        {
          "certificateUrl": "string",
          "expectedTxtRecordName": "string",
          "expectedTxtRecordValue": "string",
          "fullyQualifiedDomainName": "string",
          "identity": {
            "type": "string",
            "userAssignedIdentity": "string"
          },
          "validationState": "string"
        }
      ]
    },
    "topicSpacesConfiguration": {
      "clientAuthentication": {
        "alternativeAuthenticationNameSources": [ "string" ],
        "customJwtAuthentication": {
          "issuerCertificates": [
            {
              "certificateUrl": "string",
              "identity": {
                "type": "string",
                "userAssignedIdentity": "string"
              }
            }
          ],
          "tokenIssuer": "string"
        }
      },
      "customDomains": [
        {
          "certificateUrl": "string",
          "expectedTxtRecordName": "string",
          "expectedTxtRecordValue": "string",
          "fullyQualifiedDomainName": "string",
          "identity": {
            "type": "string",
            "userAssignedIdentity": "string"
          },
          "validationState": "string"
        }
      ],
      "maximumClientSessionsPerAuthenticationName": "int",
      "maximumSessionExpiryInHours": "int",
      "routeTopicResourceId": "string",
      "routingEnrichments": {
        "dynamic": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "static": [ {
          "key": "string",
          "valueType": "string"
          // For remaining properties, see StaticRoutingEnrichment objects
        } ]
      },
      "routingIdentityInfo": {
        "type": "string",
        "userAssignedIdentity": "string"
      },
      "state": "string"
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

StaticRoutingEnrichment オブジェクト

valueType プロパティを設定して、オブジェクトの種類を指定します。

文字列 の場合は、次の値を使用します。

{
  "value": "string",
  "valueType": "String"
}

プロパティ値

ClientAuthenticationSettings

名前 形容 価値
alternativeAuthenticationNameSources 名前空間リソースのクライアント認証設定に関連する代替認証名ソース。 次のいずれかを含む文字列配列:
'ClientCertificateDns'
'ClientCertificateEmail'
'ClientCertificateIp'
'ClientCertificateSubject'
'ClientCertificateUri'
customJwtAuthentication 名前空間リソースのカスタム JWT 認証設定。 CustomJwtAuthenticationSettings の

ConnectionState

名前 形容 価値
actionsRequired 必要なアクション (ある場合)。
形容 接続状態の説明。
地位 接続の状態。 'Approved'
'Disconnected'
'Pending'
'Rejected'

CustomDomainConfiguration

名前 形容 価値
certificateUrl カスタム ドメインへの発行に使用される証明書の URL。 現在、Azure Key Vault にのみ格納されている証明書がサポートされています。 証明書の URL は次のいずれかになります。
次の形式のバージョン管理された URL https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}、または次の形式のバージョン管理されていない URL (例:
https://contosovault.vault.azure.net/certificates/contosocert、バージョン管理されていない証明書 URL のみがサポートされます (例: https://contosovault.vault.azure.net/certificates/contosocert)
expectedTxtRecordName DNS TXT レコード名が必要です。 Event Grid では、カスタム ドメイン名の DNS レコード セットでこの名前の TXT レコードがチェックされ、ドメインの所有権が証明されます。
この TXT レコードの値には、予想される TXT レコード値が含まれている必要があります。
expectedTxtRecordValue DNS TXT レコード値が必要です。 Event Grid では、カスタム ドメイン名の DNS レコード セットでこの値を持つ TXT レコードがチェックされ、ドメインの所有権が証明されます。
fullyQualifiedDomainName カスタム ドメインの完全修飾ドメイン名 (FQDN)。 string (必須)
同一性 カスタム ドメインの証明書にアクセスするための ID 情報。 この ID 情報は、名前空間に設定されている ID と一致する必要があります。 CustomDomainIdentity の
validationState カスタム ドメインの検証状態。 これは読み取り専用プロパティであり、最初は "保留中" に設定され、ドメイン名の所有権が正常に検証された後にのみ、Event Grid によって "承認済み" に更新されます。 'Approved'
'ErrorRetrievingDnsRecord'
'Pending'

CustomDomainIdentity

名前 形容 価値
種類 使用されるマネージド ID の種類。 'SystemAssigned' または 'UserAssigned' のいずれかを指定できます。 'SystemAssigned'
'UserAssigned'
userAssignedIdentity リソースに関連付けられているユーザー ID。

CustomJwtAuthenticationManagedIdentity

名前 形容 価値
種類 使用されるマネージド ID の種類。 'SystemAssigned' または 'UserAssigned' のいずれかを指定できます。 'SystemAssigned'
'UserAssigned' (必須)
userAssignedIdentity リソースに関連付けられているユーザー ID。

CustomJwtAuthenticationSettings

名前 形容 価値
issuerCertificates トークンの検証に使用される証明書に関する情報。 現在、最大 2 つの証明書がサポートされています。 IssuerCertificateInfo[]
tokenIssuer JWT トークン発行者が必要です。

DynamicRoutingEnrichment

名前 形容 価値
動的ルーティング エンリッチメント キー。
価値 動的ルーティング エンリッチメント値。

IdentityInfo

名前 形容 価値
principalId リソース ID のプリンシパル ID。
tenantId リソースのテナント ID。
種類 使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
現在、このプロパティは使用されず、将来使用するために予約されています。
IdentityInfoUserAssignedIdentities の

IdentityInfoUserAssignedIdentities

名前 形容 価値

InboundIpRule

名前 形容 価値
アクション IpMask の一致または一致に基づいて実行するアクション。 'Allow'
ipMask CIDR 表記の IP アドレス (例: 10.0.0.0/8)。

IssuerCertificateInfo

名前 形容 価値
certificateUrl https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion 形式の Keyvault 証明書 URL。 string (必須)
同一性 証明書へのアクセスに使用される ID。 CustomJwtAuthenticationManagedIdentity の

Microsoft.EventGrid/namespaces

名前 形容 価値
apiVersion API のバージョン '2024-06-01-preview'
同一性 名前空間リソースの ID 情報。 IdentityInfo の
場所 リソースの場所。 string (必須)
名前 リソース名

制約:
最小長 = 3
最大長 = 3
パターン = ^[a-zA-Z0-9-]*$ (必須)
プロパティ 名前空間リソースのプロパティ。 NamespaceProperties の
sku 使用可能な SKU 価格レベルを表します。 NamespaceSku
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類 リソースの種類 'Microsoft.EventGrid/namespaces'

NamespaceProperties

名前 形容 価値
inboundIpRules これは、すべての IP ではなく、特定の IP からのトラフィックを制限するために使用できます。 注: これらは、PublicNetworkAccess が有効になっている場合にのみ考慮されます。 InboundIpRule[]
isZoneRedundant これは省略可能なプロパティであり、名前空間リソースがゾーン冗長機能をサポートしているかどうかをユーザーが指定できます。 この場合
プロパティがユーザーによって明示的に指定されていない場合、既定値は次の条件によって異なります。
ある。 Availability Zones が有効なリージョンの場合- 既定のプロパティ値は true になります。
b. 可用性ゾーンが有効になっていないリージョンの場合- 既定のプロパティ値は false になります。
一度指定すると、このプロパティを更新できません。
bool
minimumTlsVersionAllowed この名前空間への発行が許可されているパブリッシャーの最小 TLS バージョン。 TLS バージョン 1.2 のみがサポートされています。 '1.0'
'1.1'
'1.2'
privateEndpointConnections プライベート エンドポイント接続の一覧。 PrivateEndpointConnection[]
publicNetworkAccess これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。
seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" / <構成することで、特定の IP をさらに制限できます>
'Disabled'
'Enabled'
'SecuredByPerimeter'
topicsConfiguration 名前空間リソースのトピック構成情報 TopicsConfiguration
topicSpacesConfiguration 名前空間リソースのトピック・スペース構成情報 TopicSpacesConfiguration

NamespaceSku

名前 形容 価値
能力 名前空間の容量を定義するスループット ユニットの数を指定します。 プロパティの既定値は次の値です。
1 は、名前空間あたり 1 スループット ユニット = 1 MB/秒のイングレスと 2 MB/秒のエグレスを意味します。 最小容量は 1 で、
最大許容容量は 20 です。
int
名前 SKU の名前。 'Standard'

PrivateEndpoint

名前 形容 価値
身分証明書 プライベート エンドポイントの ARM 識別子。

PrivateEndpointConnection

名前 形容 価値
プロパティ PrivateEndpointConnection のプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 形容 価値
groupIds プライベート リンク サービス リソースの GroupId。 string[]
privateEndpoint この接続のプライベート エンドポイント リソース。 PrivateEndpoint を する
privateLinkServiceConnectionState 接続の状態に関する詳細。 ConnectionState
provisioningState プライベート エンドポイント接続のプロビジョニング状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'

RoutingEnrichments

名前 形容 価値
動的 DynamicRoutingEnrichment[]
静的 StaticRoutingEnrichment[]

RoutingIdentityInfo

名前 形容 価値
種類 トピック・スペース構成のルーティング ID タイプ。 'None'
'SystemAssigned'
'UserAssigned'
userAssignedIdentity

StaticRoutingEnrichment

名前 形容 価値
静的ルーティング エンリッチメント キー。
valueType StaticStringRoutingEnrichmentの型 'String' に設定します。 'String' (必須)

StaticStringRoutingEnrichment

名前 形容 価値
価値 文字列型ルーティング エンリッチメント値。
valueType 静的ルーティング エンリッチメント値の種類。 たとえば、このプロパティ値には "String" を指定できます。 'String' (必須)

TopicsConfiguration

名前 形容 価値
customDomains 名前空間のカスタム ドメイン構成の一覧。 CustomDomainConfiguration[]

TopicSpacesConfiguration

名前 形容 価値
clientAuthentication トピック・スペース構成のクライアント認証設定。 ClientAuthenticationSettings
customDomains 名前空間のカスタム ドメイン構成の一覧。 CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName 認証名あたりのセッションの最大数。 プロパティの既定値は 1 です。
最小許容値は 1、最大許容値は 100 です。
int
maximumSessionExpiryInHours セッションの最大有効期限 (時間単位)。 プロパティの既定値は 1 時間です。
最小値は 1 時間で、最大許容値は 8 時間です。
int
routeTopicResourceId 名前空間の下の TopicSpaces からイベントのルーティング先となる Event Grid トピックの完全修飾 Azure リソース ID。
このプロパティは、'/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft の形式にする必要があります。EventGrid/topics/{topicName}'。
このトピックは、名前空間が配置されているのと同じリージョンに存在する必要があります。
routingEnrichments トピック・スペース構成のルーティング・エンリッチメント RoutingEnrichments
routingIdentityInfo トピック・スペース構成のルーティング ID 情報。 RoutingIdentityInfo の
状態 名前空間に対してトピック スペースの構成が有効になっているかどうかを示します。 既定値は [無効] です。 'Disabled'
'Enabled'

TrackedResourceTags

名前 形容 価値

UserIdentityProperties

名前 形容 価値
clientId ユーザー割り当て ID のクライアント ID。
principalId ユーザー割り当て ID のプリンシパル ID。

Terraform (AzAPI プロバイダー) リソース定義

名前空間のリソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.EventGrid/namespaces リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces@2024-06-01-preview"
  name = "string"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      inboundIpRules = [
        {
          action = "string"
          ipMask = "string"
        }
      ]
      isZoneRedundant = bool
      minimumTlsVersionAllowed = "string"
      privateEndpointConnections = [
        {
          properties = {
            groupIds = [
              "string"
            ]
            privateEndpoint = {
              id = "string"
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
            provisioningState = "string"
          }
        }
      ]
      publicNetworkAccess = "string"
      topicsConfiguration = {
        customDomains = [
          {
            certificateUrl = "string"
            expectedTxtRecordName = "string"
            expectedTxtRecordValue = "string"
            fullyQualifiedDomainName = "string"
            identity = {
              type = "string"
              userAssignedIdentity = "string"
            }
            validationState = "string"
          }
        ]
      }
      topicSpacesConfiguration = {
        clientAuthentication = {
          alternativeAuthenticationNameSources = [
            "string"
          ]
          customJwtAuthentication = {
            issuerCertificates = [
              {
                certificateUrl = "string"
                identity = {
                  type = "string"
                  userAssignedIdentity = "string"
                }
              }
            ]
            tokenIssuer = "string"
          }
        }
        customDomains = [
          {
            certificateUrl = "string"
            expectedTxtRecordName = "string"
            expectedTxtRecordValue = "string"
            fullyQualifiedDomainName = "string"
            identity = {
              type = "string"
              userAssignedIdentity = "string"
            }
            validationState = "string"
          }
        ]
        maximumClientSessionsPerAuthenticationName = int
        maximumSessionExpiryInHours = int
        routeTopicResourceId = "string"
        routingEnrichments = {
          dynamic = [
            {
              key = "string"
              value = "string"
            }
          ]
          static = [
            {
              key = "string"
              valueType = "string"
              // For remaining properties, see StaticRoutingEnrichment objects
            }
          ]
        }
        routingIdentityInfo = {
          type = "string"
          userAssignedIdentity = "string"
        }
        state = "string"
      }
    }
  })
}

StaticRoutingEnrichment オブジェクト

valueType プロパティを設定して、オブジェクトの種類を指定します。

文字列 の場合は、次の値を使用します。

{
  value = "string"
  valueType = "String"
}

プロパティ値

ClientAuthenticationSettings

名前 形容 価値
alternativeAuthenticationNameSources 名前空間リソースのクライアント認証設定に関連する代替認証名ソース。 次のいずれかを含む文字列配列:
'ClientCertificateDns'
'ClientCertificateEmail'
'ClientCertificateIp'
'ClientCertificateSubject'
'ClientCertificateUri'
customJwtAuthentication 名前空間リソースのカスタム JWT 認証設定。 CustomJwtAuthenticationSettings の

ConnectionState

名前 形容 価値
actionsRequired 必要なアクション (ある場合)。
形容 接続状態の説明。
地位 接続の状態。 'Approved'
'Disconnected'
'Pending'
'Rejected'

CustomDomainConfiguration

名前 形容 価値
certificateUrl カスタム ドメインへの発行に使用される証明書の URL。 現在、Azure Key Vault にのみ格納されている証明書がサポートされています。 証明書の URL は次のいずれかになります。
次の形式のバージョン管理された URL https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}、または次の形式のバージョン管理されていない URL (例:
https://contosovault.vault.azure.net/certificates/contosocert、バージョン管理されていない証明書 URL のみがサポートされます (例: https://contosovault.vault.azure.net/certificates/contosocert)
expectedTxtRecordName DNS TXT レコード名が必要です。 Event Grid では、カスタム ドメイン名の DNS レコード セットでこの名前の TXT レコードがチェックされ、ドメインの所有権が証明されます。
この TXT レコードの値には、予想される TXT レコード値が含まれている必要があります。
expectedTxtRecordValue DNS TXT レコード値が必要です。 Event Grid では、カスタム ドメイン名の DNS レコード セットでこの値を持つ TXT レコードがチェックされ、ドメインの所有権が証明されます。
fullyQualifiedDomainName カスタム ドメインの完全修飾ドメイン名 (FQDN)。 string (必須)
同一性 カスタム ドメインの証明書にアクセスするための ID 情報。 この ID 情報は、名前空間に設定されている ID と一致する必要があります。 CustomDomainIdentity の
validationState カスタム ドメインの検証状態。 これは読み取り専用プロパティであり、最初は "保留中" に設定され、ドメイン名の所有権が正常に検証された後にのみ、Event Grid によって "承認済み" に更新されます。 'Approved'
'ErrorRetrievingDnsRecord'
'Pending'

CustomDomainIdentity

名前 形容 価値
種類 使用されるマネージド ID の種類。 'SystemAssigned' または 'UserAssigned' のいずれかを指定できます。 'SystemAssigned'
'UserAssigned'
userAssignedIdentity リソースに関連付けられているユーザー ID。

CustomJwtAuthenticationManagedIdentity

名前 形容 価値
種類 使用されるマネージド ID の種類。 'SystemAssigned' または 'UserAssigned' のいずれかを指定できます。 'SystemAssigned'
'UserAssigned' (必須)
userAssignedIdentity リソースに関連付けられているユーザー ID。

CustomJwtAuthenticationSettings

名前 形容 価値
issuerCertificates トークンの検証に使用される証明書に関する情報。 現在、最大 2 つの証明書がサポートされています。 IssuerCertificateInfo[]
tokenIssuer JWT トークン発行者が必要です。

DynamicRoutingEnrichment

名前 形容 価値
動的ルーティング エンリッチメント キー。
価値 動的ルーティング エンリッチメント値。

IdentityInfo

名前 形容 価値
principalId リソース ID のプリンシパル ID。
tenantId リソースのテナント ID。
種類 使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
現在、このプロパティは使用されず、将来使用するために予約されています。
IdentityInfoUserAssignedIdentities の

IdentityInfoUserAssignedIdentities

名前 形容 価値

InboundIpRule

名前 形容 価値
アクション IpMask の一致または一致に基づいて実行するアクション。 'Allow'
ipMask CIDR 表記の IP アドレス (例: 10.0.0.0/8)。

IssuerCertificateInfo

名前 形容 価値
certificateUrl https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion 形式の Keyvault 証明書 URL。 string (必須)
同一性 証明書へのアクセスに使用される ID。 CustomJwtAuthenticationManagedIdentity の

Microsoft.EventGrid/namespaces

名前 形容 価値
同一性 名前空間リソースの ID 情報。 IdentityInfo の
場所 リソースの場所。 string (必須)
名前 リソース名

制約:
最小長 = 3
最大長 = 3
パターン = ^[a-zA-Z0-9-]*$ (必須)
プロパティ 名前空間リソースのプロパティ。 NamespaceProperties の
sku 使用可能な SKU 価格レベルを表します。 NamespaceSku
タグ リソース タグ タグ名と値のディクショナリ。
種類 リソースの種類 "Microsoft.EventGrid/namespaces@2024-06-01-preview"

NamespaceProperties

名前 形容 価値
inboundIpRules これは、すべての IP ではなく、特定の IP からのトラフィックを制限するために使用できます。 注: これらは、PublicNetworkAccess が有効になっている場合にのみ考慮されます。 InboundIpRule[]
isZoneRedundant これは省略可能なプロパティであり、名前空間リソースがゾーン冗長機能をサポートしているかどうかをユーザーが指定できます。 この場合
プロパティがユーザーによって明示的に指定されていない場合、既定値は次の条件によって異なります。
ある。 Availability Zones が有効なリージョンの場合- 既定のプロパティ値は true になります。
b. 可用性ゾーンが有効になっていないリージョンの場合- 既定のプロパティ値は false になります。
一度指定すると、このプロパティを更新できません。
bool
minimumTlsVersionAllowed この名前空間への発行が許可されているパブリッシャーの最小 TLS バージョン。 TLS バージョン 1.2 のみがサポートされています。 '1.0'
'1.1'
'1.2'
privateEndpointConnections プライベート エンドポイント接続の一覧。 PrivateEndpointConnection[]
publicNetworkAccess これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。
seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" / <構成することで、特定の IP をさらに制限できます>
'Disabled'
'Enabled'
'SecuredByPerimeter'
topicsConfiguration 名前空間リソースのトピック構成情報 TopicsConfiguration
topicSpacesConfiguration 名前空間リソースのトピック・スペース構成情報 TopicSpacesConfiguration

NamespaceSku

名前 形容 価値
能力 名前空間の容量を定義するスループット ユニットの数を指定します。 プロパティの既定値は次の値です。
1 は、名前空間あたり 1 スループット ユニット = 1 MB/秒のイングレスと 2 MB/秒のエグレスを意味します。 最小容量は 1 で、
最大許容容量は 20 です。
int
名前 SKU の名前。 'Standard'

PrivateEndpoint

名前 形容 価値
身分証明書 プライベート エンドポイントの ARM 識別子。

PrivateEndpointConnection

名前 形容 価値
プロパティ PrivateEndpointConnection のプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 形容 価値
groupIds プライベート リンク サービス リソースの GroupId。 string[]
privateEndpoint この接続のプライベート エンドポイント リソース。 PrivateEndpoint を する
privateLinkServiceConnectionState 接続の状態に関する詳細。 ConnectionState
provisioningState プライベート エンドポイント接続のプロビジョニング状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'

RoutingEnrichments

名前 形容 価値
動的 DynamicRoutingEnrichment[]
静的 StaticRoutingEnrichment[]

RoutingIdentityInfo

名前 形容 価値
種類 トピック・スペース構成のルーティング ID タイプ。 'None'
'SystemAssigned'
'UserAssigned'
userAssignedIdentity

StaticRoutingEnrichment

名前 形容 価値
静的ルーティング エンリッチメント キー。
valueType StaticStringRoutingEnrichmentの型 'String' に設定します。 'String' (必須)

StaticStringRoutingEnrichment

名前 形容 価値
価値 文字列型ルーティング エンリッチメント値。
valueType 静的ルーティング エンリッチメント値の種類。 たとえば、このプロパティ値には "String" を指定できます。 'String' (必須)

TopicsConfiguration

名前 形容 価値
customDomains 名前空間のカスタム ドメイン構成の一覧。 CustomDomainConfiguration[]

TopicSpacesConfiguration

名前 形容 価値
clientAuthentication トピック・スペース構成のクライアント認証設定。 ClientAuthenticationSettings
customDomains 名前空間のカスタム ドメイン構成の一覧。 CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName 認証名あたりのセッションの最大数。 プロパティの既定値は 1 です。
最小許容値は 1、最大許容値は 100 です。
int
maximumSessionExpiryInHours セッションの最大有効期限 (時間単位)。 プロパティの既定値は 1 時間です。
最小値は 1 時間で、最大許容値は 8 時間です。
int
routeTopicResourceId 名前空間の下の TopicSpaces からイベントのルーティング先となる Event Grid トピックの完全修飾 Azure リソース ID。
このプロパティは、'/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft の形式にする必要があります。EventGrid/topics/{topicName}'。
このトピックは、名前空間が配置されているのと同じリージョンに存在する必要があります。
routingEnrichments トピック・スペース構成のルーティング・エンリッチメント RoutingEnrichments
routingIdentityInfo トピック・スペース構成のルーティング ID 情報。 RoutingIdentityInfo の
状態 名前空間に対してトピック スペースの構成が有効になっているかどうかを示します。 既定値は [無効] です。 'Disabled'
'Enabled'

TrackedResourceTags

名前 形容 価値

UserIdentityProperties

名前 形容 価値
clientId ユーザー割り当て ID のクライアント ID。
principalId ユーザー割り当て ID のプリンシパル ID。