Profiles - List By Subscription
サブスクリプション内のすべての Traffic Manager プロファイルをListsします。
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficmanagerprofiles?api-version=2022-04-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報を取得します。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。 |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
Traffic Manager プロファイルの一覧。 |
|
Other Status Codes |
既定の応答。 これは、Error 定義に従って逆シリアル化されます。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
ListBySubscription
要求のサンプル
応答のサンプル
{
"value": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/azsmnet1719/providers/Microsoft.Network/trafficManagerProfiles/azsmnet5183",
"name": "azsmnet5183",
"type": "Microsoft.Network/trafficManagerProfiles",
"location": "global",
"tags": {},
"properties": {
"profileStatus": "Enabled",
"trafficRoutingMethod": "Performance",
"dnsConfig": {
"relativeName": "azsmnet4696",
"fqdn": "azsmnet4696.tmpreview.watmtest.azure-test.net",
"ttl": 35
},
"monitorConfig": {
"profileMonitorStatus": "Online",
"protocol": "HTTP",
"port": 80,
"path": "/testpath.aspx",
"intervalInSeconds": 30,
"toleratedNumberOfFailures": 3,
"timeoutInSeconds": 10
},
"endpoints": []
}
},
{
"id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager5168/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3440",
"name": "azuresdkfornetautoresttrafficmanager3440",
"type": "Microsoft.Network/trafficManagerProfiles",
"location": "global",
"tags": {},
"properties": {
"profileStatus": "Enabled",
"trafficRoutingMethod": "Performance",
"dnsConfig": {
"relativeName": "azuresdkfornetautoresttrafficmanager3440",
"fqdn": "azuresdkfornetautoresttrafficmanager3440.tmpreview.watmtest.azure-test.net",
"ttl": 35
},
"monitorConfig": {
"profileMonitorStatus": "Online",
"protocol": "HTTP",
"port": 80,
"path": "/testpath.aspx",
"intervalInSeconds": 30,
"toleratedNumberOfFailures": 3,
"timeoutInSeconds": 10
},
"endpoints": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager5168/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3440/externalEndpoints/My external endpoint",
"name": "My external endpoint",
"type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
"properties": {
"endpointStatus": "Enabled",
"endpointMonitorStatus": "Online",
"target": "foobar.contoso.com",
"weight": 1,
"priority": 1,
"endpointLocation": "North Europe"
}
}
]
}
},
{
"id": "/subscriptions/{subscription-id}/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk8819",
"name": "onesdk8819",
"type": "Microsoft.Network/trafficManagerProfiles",
"location": "global",
"tags": {},
"properties": {
"profileStatus": "Enabled",
"trafficRoutingMethod": "Performance",
"dnsConfig": {
"relativeName": "onesdk7242",
"fqdn": "onesdk7242.tmpreview.watmtest.azure-test.net",
"ttl": 51
},
"monitorConfig": {
"profileMonitorStatus": "Online",
"protocol": "HTTPS",
"port": 111,
"path": "/testparent.asp",
"intervalInSeconds": 30,
"toleratedNumberOfFailures": 3,
"timeoutInSeconds": 10
},
"endpoints": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk8819/nestedEndpoints/MyNestedEndpoint",
"name": "MyNestedEndpoint",
"type": "Microsoft.Network/trafficManagerProfiles/nestedEndpoints",
"properties": {
"endpointStatus": "Enabled",
"endpointMonitorStatus": "Stopped",
"targetResourceId": "/subscriptions/{subscription-id}/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk1792",
"target": "onesdk4285.tmpreview.watmtest.azure-test.net",
"weight": 1,
"priority": 1,
"endpointLocation": "West Europe",
"minChildEndpoints": 1
}
}
]
}
}
]
}
定義
名前 | 説明 |
---|---|
Allowed |
このプロファイルで許可されている種類の DNS レコードの種類。 |
Always |
Always Serve が有効になっている場合、エンドポイントの正常性のプローブは無効になり、エンドポイントはトラフィック ルーティング方法に含まれます。 |
Cloud |
Azure Resource Managerによって返されるエラー |
Cloud |
Azure Resource Managerによって返されるエラーの内容 |
Custom |
カスタム ヘッダーの一覧。 |
Dns |
Traffic Manager プロファイルの DNS 設定を含むクラス。 |
Endpoint |
Traffic Manager エンドポイントを表すクラス。 |
Endpoint |
エンドポイントの監視状態。 |
Endpoint |
エンドポイントの状態。 エンドポイントが有効な場合、これはエンドポイントの正常性をプローブし、トラフィックのルーティング方法に含まれます。 |
Expected |
予期される状態コード範囲の一覧。 |
Monitor |
Traffic Manager プロファイルのエンドポイント監視設定を含むクラス。 |
Monitor |
エンドポイントの正常性のプローブに使用されるプロトコル (HTTP、HTTPS、または TCP)。 |
Profile |
Traffic Manager プロファイルを表すクラス。 |
Profile |
Traffic Manager プロファイル操作応答の一覧。 |
Profile |
Traffic Manager プロファイルのプロファイル レベルの監視状態。 |
Profile |
Traffic Manager プロファイルの状態。 |
Subnets |
"サブネット" トラフィック ルーティング方法を使用する場合に、このエンドポイントにマップされるサブネット、IP アドレス、アドレス範囲の一覧。 空のリストは、他のエンドポイントでカバーされていないすべての範囲と一致します。 |
Traffic |
Traffic Manager プロファイルのトラフィック ルーティング方法。 |
Traffic |
Traffic Manager プロファイルの Traffic View が [有効] か [無効] かを示します。 Null、 は 'Disabled' を示します。 この機能を有効にすると、Traffic Manage プロファイルのコストが増加します。 |
AllowedEndpointRecordType
このプロファイルで許可されている種類の DNS レコードの種類。
名前 | 型 | 説明 |
---|---|---|
Any |
string |
|
DomainName |
string |
|
IPv4Address |
string |
|
IPv6Address |
string |
AlwaysServe
Always Serve が有効になっている場合、エンドポイントの正常性のプローブは無効になり、エンドポイントはトラフィック ルーティング方法に含まれます。
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
CloudError
Azure Resource Managerによって返されるエラー
名前 | 型 | 説明 |
---|---|---|
error |
エラーの内容。 |
CloudErrorBody
Azure Resource Managerによって返されるエラーの内容
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード |
details |
エラーの詳細 |
|
message |
string |
エラー メッセージ |
target |
string |
エラー ターゲット |
CustomHeaders
カスタム ヘッダーの一覧。
名前 | 型 | 説明 |
---|---|---|
name |
string |
ヘッダー名。 |
value |
string |
ヘッダー値。 |
DnsConfig
Traffic Manager プロファイルの DNS 設定を含むクラス。
名前 | 型 | 説明 |
---|---|---|
fqdn |
string |
Traffic Manager プロファイルの完全修飾ドメイン名 (FQDN)。 これは、RelativeName と Azure Traffic Manager で使用される DNS ドメインの連結から形成されます。 |
relativeName |
string |
この Traffic Manager プロファイルによって提供される相対 DNS 名。 Azure Traffic Manager が使用する DNS ドメイン名とこの値を組み合わせて、プロファイルの完全修飾ドメイン名 (FQDN) が形成されます。 |
ttl |
integer |
DNS Time-To-Live (TTL) (秒単位)。 これにより、ローカル DNS リゾルバーと DNS クライアントに、この Traffic Manager プロファイルによって提供される DNS 応答をキャッシュする時間が通知されます。 |
Endpoint
Traffic Manager エンドポイントを表すクラス。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} |
name |
string |
リソースの名前 |
properties.alwaysServe |
Always Serve が有効になっている場合、エンドポイントの正常性のプローブは無効になり、エンドポイントはトラフィック ルーティング方法に含まれます。 |
|
properties.customHeaders |
カスタム ヘッダーの一覧。 |
|
properties.endpointLocation |
string |
"パフォーマンス" トラフィック ルーティング方法を使用する場合の外部エンドポイントまたは入れ子になったエンドポイントの場所を指定します。 |
properties.endpointMonitorStatus |
エンドポイントの監視状態。 |
|
properties.endpointStatus |
エンドポイントの状態。 エンドポイントが有効な場合、これはエンドポイントの正常性をプローブし、トラフィックのルーティング方法に含まれます。 |
|
properties.geoMapping |
string[] |
"地理的" トラフィック ルーティング方法を使用する場合に、このエンドポイントにマップされる国/地域の一覧。 受け入れられる値の完全な一覧については、Traffic Manager の地理的なドキュメントを参照してください。 |
properties.minChildEndpoints |
integer |
親プロファイルを使用可能と見なすために子プロファイルで使用できる必要があるエンドポイントの最小数。 型 'NestedEndpoints' のエンドポイントにのみ適用されます。 |
properties.minChildEndpointsIPv4 |
integer |
親プロファイルを使用可能と見なすために子プロファイルで使用できる必要がある IPv4 (DNS レコード タイプ A) エンドポイントの最小数。 型 'NestedEndpoints' のエンドポイントにのみ適用されます。 |
properties.minChildEndpointsIPv6 |
integer |
親プロファイルを使用可能と見なすために子プロファイルで使用できる必要がある IPv6 (DNS レコード タイプ AAAA) エンドポイントの最小数。 型 'NestedEndpoints' のエンドポイントにのみ適用されます。 |
properties.priority |
integer |
"Priority" トラフィック ルーティング方法を使用する場合の、このエンドポイントの優先度。 使用できる値は 1 から 1000 で、低い値は優先度が高いことを表します。 これは省略可能なパラメーターです。 指定した場合、すべてのエンドポイントに指定する必要があります。2 つのエンドポイントが同じ優先度の値を共有することはできません。 |
properties.subnets |
Subnets[] |
"サブネット" トラフィック ルーティング方法を使用する場合に、このエンドポイントにマップされるサブネット、IP アドレス、アドレス範囲の一覧。 空のリストは、他のエンドポイントでカバーされていないすべての範囲と一致します。 |
properties.target |
string |
エンドポイントの完全修飾 DNS 名または IP アドレス。 トラフィック マネージャーは、このエンドポイントにトラフィックをダイレクトする DNS 応答にこの値を返します。 |
properties.targetResourceId |
string |
エンドポイントの の Azure リソース URI。 "ExternalEndpoints" 型のエンドポイントには適用されません。 |
properties.weight |
integer |
"重み付け" トラフィック ルーティング方法を使用する場合の、このエンドポイントの重み。 使用できる値は 1 から 1000 です。 |
type |
string |
リソースの型。 例: Microsoft.Network/trafficManagerProfiles。 |
EndpointMonitorStatus
エンドポイントの監視状態。
名前 | 型 | 説明 |
---|---|---|
CheckingEndpoint |
string |
|
Degraded |
string |
|
Disabled |
string |
|
Inactive |
string |
|
Online |
string |
|
Stopped |
string |
|
Unmonitored |
string |
EndpointStatus
エンドポイントの状態。 エンドポイントが有効な場合、これはエンドポイントの正常性をプローブし、トラフィックのルーティング方法に含まれます。
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ExpectedStatusCodeRanges
予期される状態コード範囲の一覧。
名前 | 型 | 説明 |
---|---|---|
max |
integer |
最大状態コード。 |
min |
integer |
最小状態コード。 |
MonitorConfig
Traffic Manager プロファイルのエンドポイント監視設定を含むクラス。
名前 | 型 | 説明 |
---|---|---|
customHeaders |
カスタム ヘッダーの一覧。 |
|
expectedStatusCodeRanges |
予期される状態コード範囲の一覧。 |
|
intervalInSeconds |
integer |
このプロファイル内のエンドポイントの監視間隔。 これは、Traffic Manager がこのプロファイル内の各エンドポイントの正常性をチェックする間隔です。 |
path |
string |
エンドポイントの正常性のプローブに使用されるエンドポイント ドメイン名に対する相対パス。 |
port |
integer |
エンドポイントの正常性のプローブに使用される TCP ポート。 |
profileMonitorStatus |
Traffic Manager プロファイルのプロファイル レベルの監視状態。 |
|
protocol |
エンドポイントの正常性のプローブに使用されるプロトコル (HTTP、HTTPS、または TCP)。 |
|
timeoutInSeconds |
integer |
このプロファイル内のエンドポイントのモニター タイムアウト。 これは、Traffic Manager によって、このプロファイル内のエンドポイントが正常性チェックへの応答を許可する時間です。 |
toleratedNumberOfFailures |
integer |
このプロファイルでエンドポイントを宣言する前に Traffic Manager が許容する連続した失敗した正常性チェックの数は、次に失敗した正常性チェック後に低下します。 |
MonitorProtocol
エンドポイントの正常性のプローブに使用されるプロトコル (HTTP、HTTPS、または TCP)。
名前 | 型 | 説明 |
---|---|---|
HTTP |
string |
|
HTTPS |
string |
|
TCP |
string |
Profile
Traffic Manager プロファイルを表すクラス。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} |
location |
string |
リソースが保存されている Azure リージョン |
name |
string |
リソースの名前 |
properties.allowedEndpointRecordTypes |
許可されるエンドポイント レコードの種類の一覧。 |
|
properties.dnsConfig |
Traffic Manager プロファイルの DNS 設定。 |
|
properties.endpoints |
Endpoint[] |
Traffic Manager プロファイル内のエンドポイントの一覧。 |
properties.maxReturn |
integer |
MultiValue ルーティングの種類に対して返されるエンドポイントの最大数。 |
properties.monitorConfig |
Traffic Manager プロファイルのエンドポイント監視設定。 |
|
properties.profileStatus |
Traffic Manager プロファイルの状態。 |
|
properties.trafficRoutingMethod |
Traffic Manager プロファイルのトラフィック ルーティング方法。 |
|
properties.trafficViewEnrollmentStatus |
Traffic Manager プロファイルの Traffic View が [有効] か [無効] かを示します。 Null、 は 'Disabled' を示します。 この機能を有効にすると、Traffic Manage プロファイルのコストが増加します。 |
|
tags |
object |
リソース タグ。 |
type |
string |
リソースの型。 例: Microsoft.Network/trafficManagerProfiles。 |
ProfileListResult
Traffic Manager プロファイル操作応答の一覧。
名前 | 型 | 説明 |
---|---|---|
value |
Profile[] |
Traffic Manager プロファイルの一覧を取得します。 |
ProfileMonitorStatus
Traffic Manager プロファイルのプロファイル レベルの監視状態。
名前 | 型 | 説明 |
---|---|---|
CheckingEndpoints |
string |
|
Degraded |
string |
|
Disabled |
string |
|
Inactive |
string |
|
Online |
string |
ProfileStatus
Traffic Manager プロファイルの状態。
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
Subnets
"サブネット" トラフィック ルーティング方法を使用する場合に、このエンドポイントにマップされるサブネット、IP アドレス、アドレス範囲の一覧。 空のリストは、他のエンドポイントでカバーされていないすべての範囲と一致します。
名前 | 型 | 説明 |
---|---|---|
first |
string |
サブネット内の最初のアドレス。 |
last |
string |
サブネット内の最後のアドレス。 |
scope |
integer |
ブロック サイズ (サブネット マスク内の先頭ビットの数)。 |
TrafficRoutingMethod
Traffic Manager プロファイルのトラフィック ルーティング方法。
名前 | 型 | 説明 |
---|---|---|
Geographic |
string |
|
MultiValue |
string |
|
Performance |
string |
|
Priority |
string |
|
Subnet |
string |
|
Weighted |
string |
TrafficViewEnrollmentStatus
Traffic Manager プロファイルの Traffic View が [有効] か [無効] かを示します。 Null、 は 'Disabled' を示します。 この機能を有効にすると、Traffic Manage プロファイルのコストが増加します。
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |