次の方法で共有


Front Doors - Get

指定したサブスクリプションとリソース グループの下に指定された Front Door 名を持つ Front Door を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}?api-version=2019-05-01

URI パラメーター

名前 / 必須 説明
frontDoorName
path True

string

グローバルに一意である Front Door の名前。

正規表現パターン: ^[a-zA-Z0-9]+([-a-zA-Z0-9]?[a-zA-Z0-9])*$

resourceGroupName
path True

string

Azure サブスクリプション内のリソース グループの名前。

正規表現パターン: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$

subscriptionId
path True

string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプションの資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True

string

クライアント API バージョン。

応答

名前 説明
200 OK

FrontDoor

OK です。 要求は成功しました。

Other Status Codes

ErrorResponse

操作が失敗した理由を説明する Front Door エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

Get Front Door

要求のサンプル

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1?api-version=2019-05-01

応答のサンプル

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1",
  "name": "frontDoor1",
  "type": "Microsoft.Network/frontDoor",
  "location": "westus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "routingRules": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/routingRule1",
        "name": "routingRule1",
        "properties": {
          "frontendEndpoints": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default"
            }
          ],
          "acceptedProtocols": [
            "Http"
          ],
          "patternsToMatch": [
            "/*"
          ],
          "routeConfiguration": {
            "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
            "customForwardingPath": "",
            "forwardingProtocol": "MatchRequest",
            "backendPool": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1"
            }
          },
          "enabledState": "Enabled"
        }
      }
    ],
    "healthProbeSettings": [
      {
        "name": "healthProbeSettings1",
        "properties": {
          "path": "/",
          "protocol": "Http",
          "intervalInSeconds": 120,
          "enabledState": "Enabled",
          "healthProbeMethod": "HEAD"
        }
      }
    ],
    "loadBalancingSettings": [
      {
        "name": "loadBalancingSettings1",
        "properties": {
          "sampleSize": 4,
          "successfulSamplesRequired": 2
        }
      }
    ],
    "backendPools": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1",
        "name": "backendPool1",
        "properties": {
          "backends": [
            {
              "address": "w3.contoso.com",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 1,
              "priority": 2
            },
            {
              "address": "contoso.com.website-us-west-2.othercloud.net",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 2,
              "priority": 1
            },
            {
              "address": "contoso1.azurewebsites.net",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 1,
              "priority": 1
            }
          ],
          "loadBalancingSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1"
          },
          "healthProbeSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1"
          }
        }
      }
    ],
    "frontendEndpoints": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1",
        "name": "frontendEndpoint1",
        "properties": {
          "hostName": "www.contoso.com",
          "sessionAffinityEnabledState": "Enabled",
          "sessionAffinityTtlSeconds": 60,
          "webApplicationFirewallPolicyLink": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1"
          }
        }
      },
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default",
        "name": "default",
        "properties": {
          "hostName": "frontDoor1.azurefd.net"
        }
      }
    ],
    "backendPoolsSettings": {
      "enforceCertificateNameCheck": "Enabled",
      "sendRecvTimeoutSeconds": 60
    },
    "enabledState": "Enabled",
    "resourceState": "Enabled",
    "provisioningState": "Succeeded",
    "cname": "frontDoor1.azurefd.net"
  }
}

定義

名前 説明
Backend

frontDoor ロード バランサーのバックエンド アドレス。

backendEnabledState

このバックエンドの使用を許可するかどうか。 許可される値は 'Enabled' または 'Disabled' です

BackendPool

バックエンド プールは、ルーティングできるバックエンドのコレクションです。

BackendPoolsSettings

すべてのバックエンド プールに適用される設定。

CacheConfiguration

キャッシュの種類のルートのキャッシュ設定。 キャッシュを無効にするには、cacheConfiguration オブジェクトを指定しないでください。

CustomHttpsConfiguration

ドメインの Https 設定

CustomHttpsProvisioningState

frontendEndpoint のカスタム Https のプロビジョニング状態。

CustomHttpsProvisioningSubstate

プロビジョニング サブ状態は、カスタム HTTPS の有効化/無効化プロセスの進行状況を段階的に示します。

DynamicCompressionEnabled

キャッシュされたコンテンツに動的圧縮を使用するかどうか

enforceCertificateNameCheckEnabledState

すべてのバックエンド プールに対して HTTPS 要求に証明書名チェックを適用するかどうか。 HTTPS 以外の要求には影響しません。

ErrorResponse

エラー応答は、Front Door サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。

ForwardingConfiguration

転送ルートについて説明します。

FrontDoor

Front Door は、トラフィックの送信先を指定するルールと共に、トラフィックをルーティングするバックエンド エンドポイントのコレクションを表します。

FrontDoorCertificateSource

SSL 証明書のソースを定義します

FrontDoorCertificateType

frontendEndpoint へのセキュリティで保護された接続に使用される証明書の種類を定義します

FrontDoorEnabledState

Front Door ロード バランサーの運用状態。 許可される値は 'Enabled' または 'Disabled' です

FrontDoorForwardingProtocol

バックエンドにトラフィックを転送するときに、このルールが使用するプロトコル。

FrontDoorHealthProbeMethod

backendPools で定義されているバックエンドをプローブするために使用する HTTP メソッドを構成します。

FrontDoorProtocol

この規則に一致するプロトコル スキーム

FrontDoorQuery

キャッシュ キーを形成するときの URL クエリ用語の処理。

FrontDoorRedirectProtocol

トラフィックがリダイレクトされる宛先のプロトコル

FrontDoorRedirectType

トラフィックをリダイレクトするときにルールが使用するリダイレクトの種類。

FrontDoorResourceState

Front Door または Front Door SubResource のリソースの状態。

FrontDoorTlsProtocolType

セキュリティで保護された配信に使用される TLS 拡張機能プロトコルを定義します

FrontendEndpoint

ルーティングに使用されるフロントエンド エンドポイント。

HealthProbeEnabled

backendPools で定義されたバックエンドに対して正常性プローブを有効にするかどうか。 正常性プローブを無効にできるのは、1 つの有効なバックエンド プールに 1 つの有効なバックエンドがある場合のみです。

HealthProbeSettingsModel

バックエンド プールの負荷分散設定

LoadBalancingSettingsModel

バックエンド プールの負荷分散設定

MinimumTLSVersion

Front Door で SSL ハンドシェイクを確立するためにクライアントから必要な最小 TLS バージョン。

RedirectConfiguration

リダイレクト ルートについて説明します。

RoutingRule

ルーティング規則は、正常性プローブ情報と共に、処理するトラフィックとその送信先の仕様を表します。

routingRuleEnabledState

この規則の使用を許可するかどうか。 許可される値は 'Enabled' または 'Disabled' です

SessionAffinityEnabledState

このホスト上のセッション アフィニティを許可するかどうか。 有効なオプションは 'Enabled' または 'Disabled' です

SubResource

別のサブリソースへの参照。

Vault

SSL 証明書を格納する Key Vault

WebApplicationFirewallPolicyLink

各ホストのWeb Application Firewall ポリシーを定義します (該当する場合)

Backend

frontDoor ロード バランサーのバックエンド アドレス。

名前 説明
address

string

バックエンドの場所 (IP または FQDN)。

backendHostHeader

string

バックエンドに送信するホスト ヘッダーとして使用する値。 空白または指定されていない場合、これは既定で受信ホストに設定されます。

enabledState

backendEnabledState

このバックエンドの使用を許可するかどうか。 許可される値は 'Enabled' または 'Disabled' です

httpPort

integer

HTTP TCP のポート番号。 1 から 65535 の間である必要があります。

httpsPort

integer

HTTPS の TCP ポート番号。 1 から 65535 の間である必要があります。

priority

integer

負荷分散の優先順位。 優先順位の低いバックエンドが正常な場合、より高い優先順位は負荷分散には使用されません。

weight

integer

負荷分散のためのこのエンドポイントの重み。

backendEnabledState

このバックエンドの使用を許可するかどうか。 許可される値は 'Enabled' または 'Disabled' です

名前 説明
Disabled

string

Enabled

string

BackendPool

バックエンド プールは、ルーティングできるバックエンドのコレクションです。

名前 説明
id

string

リソースの ID

name

string

リソース名。

properties.backends

Backend[]

このプールのバックエンドのセット

properties.healthProbeSettings

SubResource

バックエンド プールの L7 正常性プローブ設定

properties.loadBalancingSettings

SubResource

バックエンド プールの負荷分散設定

properties.resourceState

FrontDoorResourceState

Front Door または Front Door SubResource のリソースの状態。
リソースの状態。

type

string

リソースの種類。

BackendPoolsSettings

すべてのバックエンド プールに適用される設定。

名前 規定値 説明
enforceCertificateNameCheck

enforceCertificateNameCheckEnabledState

Enabled

すべてのバックエンド プールに対して HTTPS 要求に証明書名チェックを適用するかどうか。 HTTPS 以外の要求には影響しません。

sendRecvTimeoutSeconds

integer

バックエンドへの要求の転送時にタイムアウトを送受信します。 タイムアウトに達すると、要求は失敗し、 が返されます。

CacheConfiguration

キャッシュの種類のルートのキャッシュ設定。 キャッシュを無効にするには、cacheConfiguration オブジェクトを指定しないでください。

名前 説明
dynamicCompression

DynamicCompressionEnabled

キャッシュされたコンテンツに動的圧縮を使用するかどうか

queryParameterStripDirective

FrontDoorQuery

キャッシュ キーを形成するときの URL クエリ用語の処理。

CustomHttpsConfiguration

ドメインの Https 設定

名前 説明
certificateSource

FrontDoorCertificateSource

SSL 証明書のソースを定義します

frontDoorCertificateSourceParameters.certificateType

FrontDoorCertificateType

frontendEndpoint へのセキュリティで保護された接続に使用される証明書の種類を定義します

keyVaultCertificateSourceParameters.secretName

string

完全な証明書 PFX を表す Key Vault シークレットの名前

keyVaultCertificateSourceParameters.secretVersion

string

完全な証明書 PFX を表す Key Vault シークレットのバージョン

keyVaultCertificateSourceParameters.vault

Vault

SSL 証明書を格納する Key Vault

minimumTlsVersion

MinimumTLSVersion

Front Door で SSL ハンドシェイクを確立するためにクライアントから必要な最小 TLS バージョン。

protocolType

FrontDoorTlsProtocolType

セキュリティで保護された配信に使用される TLS 拡張機能プロトコルを定義します

CustomHttpsProvisioningState

frontendEndpoint のカスタム Https のプロビジョニング状態。

名前 説明
Disabled

string

Disabling

string

Enabled

string

Enabling

string

Failed

string

CustomHttpsProvisioningSubstate

プロビジョニング サブ状態は、カスタム HTTPS の有効化/無効化プロセスの進行状況を段階的に示します。

名前 説明
CertificateDeleted

string

CertificateDeployed

string

DeletingCertificate

string

DeployingCertificate

string

DomainControlValidationRequestApproved

string

DomainControlValidationRequestRejected

string

DomainControlValidationRequestTimedOut

string

IssuingCertificate

string

PendingDomainControlValidationREquestApproval

string

SubmittingDomainControlValidationRequest

string

DynamicCompressionEnabled

キャッシュされたコンテンツに動的圧縮を使用するかどうか

名前 説明
Disabled

string

Enabled

string

enforceCertificateNameCheckEnabledState

すべてのバックエンド プールに対して HTTPS 要求に証明書名チェックを適用するかどうか。 HTTPS 以外の要求には影響しません。

名前 説明
Disabled

string

Enabled

string

ErrorResponse

エラー応答は、Front Door サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。

名前 説明
code

string

エラー コード。

message

string

操作が失敗した理由を示すエラー メッセージ。

ForwardingConfiguration

転送ルートについて説明します。

名前 説明
@odata.type string:

#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration

backendPool

SubResource

この規則のルーティング先となる BackendPool への参照。

cacheConfiguration

CacheConfiguration

この規則に関連付けられているキャッシュ構成。

customForwardingPath

string

この規則に一致するリソース パスを書き換えるために使用されるカスタム パス。 受信パスを使用するには空のままにします。

forwardingProtocol

FrontDoorForwardingProtocol

バックエンドにトラフィックを転送するときに、このルールが使用するプロトコル。

FrontDoor

Front Door は、トラフィックの送信先を指定するルールと共に、トラフィックをルーティングするバックエンド エンドポイントのコレクションを表します。

名前 説明
id

string

リソースの ID

location

string

リソースの場所。

name

string

リソース名。

properties.backendPools

BackendPool[]

ルーティング規則で使用できるバックエンド プール。

properties.backendPoolsSettings

BackendPoolsSettings

すべての backendPools の設定

properties.cname

string

各 frontendEndpoint で CNAME が必要なホスト。

properties.enabledState

FrontDoorEnabledState

Front Door ロード バランサーの運用状態。 許可される値は 'Enabled' または 'Disabled' です

properties.friendlyName

string

frontDoor のフレンドリ名

properties.frontendEndpoints

FrontendEndpoint[]

ルーティング規則で使用できるフロントエンド エンドポイント。

properties.healthProbeSettings

HealthProbeSettingsModel[]

この Front Door インスタンスに関連付けられている正常性プローブの設定。

properties.loadBalancingSettings

LoadBalancingSettingsModel[]

この Front Door インスタンスに関連付けられている負荷分散の設定。

properties.provisioningState

string

Front Door のプロビジョニング状態。

properties.resourceState

FrontDoorResourceState

Front Door または Front Door SubResource のリソースの状態。
Front Door のリソースの状態。

properties.routingRules

RoutingRule[]

この Front Door に関連付けられているルーティング規則。

tags

object

リソース タグ。

type

string

リソースの種類。

FrontDoorCertificateSource

SSL 証明書のソースを定義します

名前 説明
AzureKeyVault

string

FrontDoor

string

FrontDoorCertificateType

frontendEndpoint へのセキュリティで保護された接続に使用される証明書の種類を定義します

名前 説明
Dedicated

string

FrontDoorEnabledState

Front Door ロード バランサーの運用状態。 許可される値は 'Enabled' または 'Disabled' です

名前 説明
Disabled

string

Enabled

string

FrontDoorForwardingProtocol

バックエンドにトラフィックを転送するときに、このルールが使用するプロトコル。

名前 説明
HttpOnly

string

HttpsOnly

string

MatchRequest

string

FrontDoorHealthProbeMethod

backendPools で定義されているバックエンドをプローブするために使用する HTTP メソッドを構成します。

名前 説明
GET

string

HEAD

string

FrontDoorProtocol

この規則に一致するプロトコル スキーム

名前 説明
Http

string

Https

string

FrontDoorQuery

キャッシュ キーを形成するときの URL クエリ用語の処理。

名前 説明
StripAll

string

StripNone

string

FrontDoorRedirectProtocol

トラフィックがリダイレクトされる宛先のプロトコル

名前 説明
HttpOnly

string

HttpsOnly

string

MatchRequest

string

FrontDoorRedirectType

トラフィックをリダイレクトするときにルールが使用するリダイレクトの種類。

名前 説明
Found

string

Moved

string

PermanentRedirect

string

TemporaryRedirect

string

FrontDoorResourceState

Front Door または Front Door SubResource のリソースの状態。

名前 説明
Creating

string

Deleting

string

Disabled

string

Disabling

string

Enabled

string

Enabling

string

FrontDoorTlsProtocolType

セキュリティで保護された配信に使用される TLS 拡張機能プロトコルを定義します

名前 説明
ServerNameIndication

string

FrontendEndpoint

ルーティングに使用されるフロントエンド エンドポイント。

名前 説明
id

string

リソースの ID

name

string

リソース名。

properties.customHttpsConfiguration

CustomHttpsConfiguration

HTTPS を有効にする方法を指定する構成

properties.customHttpsProvisioningState

CustomHttpsProvisioningState

frontendEndpoint のカスタム Https のプロビジョニング状態。

properties.customHttpsProvisioningSubstate

CustomHttpsProvisioningSubstate

プロビジョニング サブ状態は、カスタム HTTPS の有効化/無効化プロセスの進行状況を段階的に示します。

properties.hostName

string

frontendEndpoint のホスト名。 ドメイン名を指定してください。

properties.resourceState

FrontDoorResourceState

Front Door または Front Door SubResource のリソースの状態。
リソースの状態。

properties.sessionAffinityEnabledState

SessionAffinityEnabledState

このホスト上のセッション アフィニティを許可するかどうか。 有効なオプションは 'Enabled' または 'Disabled' です

properties.sessionAffinityTtlSeconds

integer

未使用。 このフィールドは無視されます。 セッション アフィニティで使用する TTL (秒) (該当する場合)。

properties.webApplicationFirewallPolicyLink

WebApplicationFirewallPolicyLink

各ホストのWeb Application Firewall ポリシーを定義します (該当する場合)

type

string

リソースの種類。

HealthProbeEnabled

backendPools で定義されたバックエンドに対して正常性プローブを有効にするかどうか。 正常性プローブを無効にできるのは、1 つの有効なバックエンド プールに 1 つの有効なバックエンドがある場合のみです。

名前 説明
Disabled

string

Enabled

string

HealthProbeSettingsModel

バックエンド プールの負荷分散設定

名前 規定値 説明
id

string

リソースの ID

name

string

リソース名。

properties.enabledState

HealthProbeEnabled

backendPools で定義されたバックエンドに対して正常性プローブを有効にするかどうか。 正常性プローブを無効にできるのは、1 つの有効なバックエンド プールに 1 つの有効なバックエンドがある場合のみです。

properties.healthProbeMethod

FrontDoorHealthProbeMethod

HEAD

backendPools で定義されているバックエンドをプローブするために使用する HTTP メソッドを構成します。

properties.intervalInSeconds

integer

正常性プローブ間の秒数。

properties.path

string

正常性プローブに使用するパス。 既定は /。

properties.protocol

FrontDoorProtocol

このプローブに使用するプロトコル スキーム

properties.resourceState

FrontDoorResourceState

Front Door または Front Door SubResource のリソースの状態。
リソースの状態。

type

string

リソースの種類。

LoadBalancingSettingsModel

バックエンド プールの負荷分散設定

名前 説明
id

string

リソースの ID

name

string

リソース名。

properties.additionalLatencyMilliseconds

integer

プローブが最も短い待機時間バケットに分類されるまでの追加の待機時間 (ミリ秒単位)

properties.resourceState

FrontDoorResourceState

Front Door または Front Door SubResource のリソースの状態。
リソースの状態。

properties.sampleSize

integer

負荷分散の決定に考慮するサンプルの数

properties.successfulSamplesRequired

integer

成功する必要があるサンプル期間内のサンプルの数

type

string

リソースの種類。

MinimumTLSVersion

Front Door で SSL ハンドシェイクを確立するためにクライアントから必要な最小 TLS バージョン。

名前 説明
1.0

string

1.2

string

RedirectConfiguration

リダイレクト ルートについて説明します。

名前 説明
@odata.type string:

#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration

customFragment

string

リダイレクト URL に追加するフラグメント。 フラグメントは、 # の後に来る URL の一部です。 #を含めないでください。

customHost

string

リダイレクトするホスト。 受信ホストを宛先ホストとして使用するには、空のままにします。

customPath

string

リダイレクトする完全なパス。 パスを空にすることはできません。/で始まる必要があります。 受信パスを宛先パスとして使用するには、空のままにします。

customQueryString

string

リダイレクト URL に配置するクエリ文字列のセット。 この値を設定すると、既存のクエリ文字列が置き換えられます。受信クエリ文字列を保持するには、空のままにします。 クエリ文字列は = 形式である必要があります。 最初の ? & は自動的に追加されるため、先頭に含めるのではなく、複数のクエリ文字列を & で区切ります。

redirectProtocol

FrontDoorRedirectProtocol

トラフィックがリダイレクトされる宛先のプロトコル

redirectType

FrontDoorRedirectType

トラフィックをリダイレクトするときにルールが使用するリダイレクトの種類。

RoutingRule

ルーティング規則は、正常性プローブ情報と共に、処理するトラフィックとその送信先の仕様を表します。

名前 説明
id

string

リソースの ID

name

string

リソース名。

properties.acceptedProtocols

FrontDoorProtocol[]

この規則に一致するプロトコル スキーム

properties.enabledState

routingRuleEnabledState

この規則の使用を許可するかどうか。 許可される値は 'Enabled' または 'Disabled' です

properties.frontendEndpoints

SubResource[]

このルールに関連付けられているフロントエンド エンドポイント

properties.patternsToMatch

string[]

ルールのルート パターン。

properties.resourceState

FrontDoorResourceState

Front Door または Front Door SubResource のリソースの状態。
リソースの状態。

properties.routeConfiguration RouteConfiguration:

ルーティング構成への参照。

type

string

リソースの種類。

routingRuleEnabledState

この規則の使用を許可するかどうか。 許可される値は 'Enabled' または 'Disabled' です

名前 説明
Disabled

string

Enabled

string

SessionAffinityEnabledState

このホスト上のセッション アフィニティを許可するかどうか。 有効なオプションは 'Enabled' または 'Disabled' です

名前 説明
Disabled

string

Enabled

string

SubResource

別のサブリソースへの参照。

名前 説明
id

string

リソースの ID

Vault

SSL 証明書を格納する Key Vault

名前 説明
id

string

リソースの ID

各ホストのWeb Application Firewall ポリシーを定義します (該当する場合)

名前 説明
id

string

リソースの ID