Contact Profiles - Create Or Update
連絡先プロファイルを作成または更新します。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}?api-version=2022-11-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
contact
|
path | True |
string |
連絡先プロファイル名。 |
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
location | True |
string |
リソースが保存されている地理的な場所 |
properties.links | True |
連絡先プロファイルのリンク。 RF リンク、モデム処理、IP エンドポイントについて説明します。 |
|
properties.networkConfiguration | True |
顧客仮想ネットワークのネットワーク構成。 |
|
properties.autoTrackingConfiguration |
自動追跡の構成。 |
||
properties.eventHubUri |
string |
テレメトリに使用されるイベント ハブの ARM リソース識別子。 Orbital リソース プロバイダーに、ハブにテレメトリを送信する権限を付与する必要があります。 |
|
properties.minimumElevationDegrees |
number |
接触の実行可能な最小標高 (10 進度)。 特定の地上局の宇宙船で使用可能な連絡先を一覧表示するために使用されます。 |
|
properties.minimumViableContactDuration |
string |
ISO 8601 形式の実行可能な最小接触時間。 特定の地上局の宇宙船で使用可能な連絡先を一覧表示するために使用されます。 |
|
properties.provisioningState |
リソースの作成、削除、または変更の現在の状態。 |
||
properties.thirdPartyConfigurations |
連絡先プロファイルのサード パーティのミッション構成。 RF リンク、モデム処理、IP エンドポイントについて説明します。 |
||
tags |
object |
リソース タグ。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
更新が成功しました。 操作は、結果の ContactProfile リソースを返します。 |
|
201 Created |
正常に作成します。 操作は、結果の ContactProfile リソースを返します。 ヘッダー Azure-AsyncOperation: string |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
例
Create a contact profile
要求のサンプル
PUT https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP?api-version=2022-11-01
{
"location": "eastus2",
"properties": {
"minimumViableContactDuration": "PT1M",
"minimumElevationDegrees": 5,
"autoTrackingConfiguration": "disabled",
"eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub",
"networkConfiguration": {
"subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"
},
"thirdPartyConfigurations": [
{
"providerName": "KSAT",
"missionConfiguration": "Ksat_MissionConfiguration"
},
{
"providerName": "VIASAT",
"missionConfiguration": "Viasat_Configuration"
}
],
"links": [
{
"name": "contoso-uplink",
"polarization": "LHCP",
"direction": "Uplink",
"gainOverTemperature": 0,
"eirpdBW": 45,
"channels": [
{
"name": "contoso-uplink-channel",
"centerFrequencyMHz": 2250,
"bandwidthMHz": 2,
"endPoint": {
"ipAddress": "10.1.0.4",
"endPointName": "ContosoTest_Uplink",
"port": "50000",
"protocol": "TCP"
}
}
]
},
{
"name": "contoso-downlink",
"polarization": "RHCP",
"direction": "Downlink",
"gainOverTemperature": 25,
"eirpdBW": 0,
"channels": [
{
"name": "contoso-downlink-channel",
"centerFrequencyMHz": 8160,
"bandwidthMHz": 15,
"endPoint": {
"ipAddress": "10.1.0.5",
"endPointName": "ContosoTest_Downlink",
"port": "50001",
"protocol": "UDP"
}
}
]
}
]
}
}
応答のサンプル
Azure-AsyncOperation: https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01
{
"location": "eastus2",
"tags": null,
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP",
"name": "CONTOSO-CP",
"type": "Microsoft.Orbital/contactProfiles",
"properties": {
"provisioningState": "updating",
"minimumViableContactDuration": "PT1M",
"minimumElevationDegrees": 5,
"autoTrackingConfiguration": "disabled",
"eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub",
"networkConfiguration": {
"subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"
},
"thirdPartyConfigurations": [
{
"providerName": "KSAT",
"missionConfiguration": "Ksat_MissionConfiguration"
},
{
"providerName": "VIASAT",
"missionConfiguration": "Viasat_Configuration"
}
],
"links": [
{
"name": "contoso-uplink",
"polarization": "LHCP",
"direction": "Uplink",
"gainOverTemperature": 0,
"eirpdBW": 45,
"channels": [
{
"name": "contoso-uplink-channel",
"centerFrequencyMHz": 2250,
"bandwidthMHz": 2,
"endPoint": {
"ipAddress": "10.1.0.4",
"endPointName": "ContosoTest_Uplink",
"port": "50000",
"protocol": "TCP"
},
"modulationConfiguration": null,
"demodulationConfiguration": null,
"encodingConfiguration": null,
"decodingConfiguration": null
}
]
},
{
"name": "contoso-downlink",
"polarization": "RHCP",
"direction": "Downlink",
"gainOverTemperature": 25,
"eirpdBW": 0,
"channels": [
{
"name": "contoso-downlink-channel",
"centerFrequencyMHz": 8160,
"bandwidthMHz": 15,
"endPoint": {
"ipAddress": "10.1.0.5",
"endPointName": "ContosoTest_Downlink",
"port": "50001",
"protocol": "UDP"
},
"modulationConfiguration": null,
"demodulationConfiguration": null,
"encodingConfiguration": null,
"decodingConfiguration": null
}
]
}
]
}
}
Azure-AsyncOperation: https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01
{
"location": "eastus2",
"tags": null,
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP",
"name": "CONTOSO-CP",
"type": "Microsoft.Orbital/contactProfiles",
"properties": {
"provisioningState": "succeeded",
"minimumViableContactDuration": "PT1M",
"minimumElevationDegrees": 5,
"autoTrackingConfiguration": "disabled",
"eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub",
"networkConfiguration": {
"subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"
},
"thirdPartyConfigurations": [
{
"providerName": "KSAT",
"missionConfiguration": "Ksat_MissionConfiguration"
},
{
"providerName": "VIASAT",
"missionConfiguration": "Viasat_Configuration"
}
],
"links": [
{
"name": "contoso-uplink",
"polarization": "LHCP",
"direction": "Uplink",
"gainOverTemperature": 0,
"eirpdBW": 45,
"channels": [
{
"name": "contoso-uplink-channel",
"centerFrequencyMHz": 2250,
"bandwidthMHz": 2,
"endPoint": {
"ipAddress": "10.1.0.4",
"endPointName": "ContosoTest_Uplink",
"port": "50000",
"protocol": "TCP"
},
"modulationConfiguration": null,
"demodulationConfiguration": null,
"encodingConfiguration": null,
"decodingConfiguration": null
}
]
},
{
"name": "contoso-downlink",
"polarization": "RHCP",
"direction": "Downlink",
"gainOverTemperature": 25,
"eirpdBW": 0,
"channels": [
{
"name": "contoso-downlink-channel",
"centerFrequencyMHz": 8160,
"bandwidthMHz": 15,
"endPoint": {
"ipAddress": "10.1.0.5",
"endPointName": "ContosoTest_Downlink",
"port": "50001",
"protocol": "UDP"
},
"modulationConfiguration": null,
"demodulationConfiguration": null,
"encodingConfiguration": null,
"decodingConfiguration": null
}
]
}
]
}
}
定義
名前 | 説明 |
---|---|
Auto |
自動追跡の構成。 |
Contact |
顧客が連絡先プロファイル リソースを作成します。このリソースには、連絡先のスケジュール設定に必要なすべての構成が含まれます。 |
Contact |
連絡先プロファイル リンク。 |
Contact |
連絡先プロファイル リンク チャネル。 |
Contact |
プロファイルのサード パーティのパートナー構成にお問い合わせください。 |
created |
リソースを作成した ID の種類。 |
direction |
方向 (アップリンクまたはダウンリンク)。 |
End |
宇宙船との接触中にデータを格納および取得する顧客エンドポイント。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Network |
顧客仮想ネットワークのネットワーク構成。 |
polarization |
偏光。 例: (RHCP、LHCP)。 |
protocol |
UDP または TCP のいずれかのプロトコル。 |
Provisioning |
リソースの作成、削除、または変更の現在の状態。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
AutoTrackingConfiguration
自動追跡の構成。
名前 | 型 | 説明 |
---|---|---|
disabled |
string |
|
sBand |
string |
|
xBand |
string |
ContactProfile
顧客が連絡先プロファイル リソースを作成します。このリソースには、連絡先のスケジュール設定に必要なすべての構成が含まれます。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
リソースが保存されている地理的な場所 |
name |
string |
リソースの名前 |
properties.autoTrackingConfiguration |
自動追跡の構成。 |
|
properties.eventHubUri |
string |
テレメトリに使用されるイベント ハブの ARM リソース識別子。 Orbital リソース プロバイダーに、ハブにテレメトリを送信する権限を付与する必要があります。 |
properties.links |
連絡先プロファイルのリンク。 RF リンク、モデム処理、IP エンドポイントについて説明します。 |
|
properties.minimumElevationDegrees |
number |
接触の実行可能な最小標高 (10 進度)。 特定の地上局の宇宙船で使用可能な連絡先を一覧表示するために使用されます。 |
properties.minimumViableContactDuration |
string |
ISO 8601 形式の実行可能な最小接触時間。 特定の地上局の宇宙船で使用可能な連絡先を一覧表示するために使用されます。 |
properties.networkConfiguration |
顧客仮想ネットワークのネットワーク構成。 |
|
properties.provisioningState |
リソースの作成、削除、または変更の現在の状態。 |
|
properties.thirdPartyConfigurations |
連絡先プロファイルのサード パーティのミッション構成。 RF リンク、モデム処理、IP エンドポイントについて説明します。 |
|
systemData |
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
|
tags |
object |
リソース タグ。 |
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
ContactProfileLink
連絡先プロファイル リンク。
名前 | 型 | 説明 |
---|---|---|
channels |
連絡先プロファイル リンク チャネル。 |
|
direction |
方向 (アップリンクまたはダウンリンク)。 |
|
eirpdBW |
number |
dBWにおける有効等方放射電力(EIRP) これは、顧客が必要とする EIRP です。 まだ使用されていません。 |
gainOverTemperature |
number |
db/K のノイズ温度に対するゲイン。 これは、顧客が必要とする G/T です。 まだ使用されていません。 |
name |
string |
リンク名。 |
polarization |
偏光。 例: (RHCP、LHCP)。 |
ContactProfileLinkChannel
連絡先プロファイル リンク チャネル。
名前 | 型 | 説明 |
---|---|---|
bandwidthMHz |
number |
MHz の帯域幅。 |
centerFrequencyMHz |
number |
MHz の中心周波数。 |
decodingConfiguration |
string |
現在使用されていません。 |
demodulationConfiguration |
string |
Kratos QRadio や Kratos QuantumRx などのモデム構成ファイルのコピー。 下り方向にのみ有効です。 指定した場合、モデムは顧客エンドポイントに接続し、VITA.49 ストリームの代わりに降格されたデータを送信します。 |
encodingConfiguration |
string |
現在使用されていません。 |
endPoint |
宇宙船との接触中にデータを格納および取得する顧客エンドポイント。 |
|
modulationConfiguration |
string |
Kratos QRadio などのモデム構成ファイルのコピー。 アップリンク方向に対してのみ有効です。 指定した場合、モデムは顧客エンドポイントに接続し、VITA.49 ストリームの代わりに顧客からのコマンドを受け入れます。 |
name |
string |
チャネル名。 |
ContactProfileThirdPartyConfiguration
プロファイルのサード パーティのパートナー構成にお問い合わせください。
名前 | 型 | 説明 |
---|---|---|
missionConfiguration |
string |
特定のミッションの連絡先設定を記述する構成を参照する文字列の名前。 予想される値は、パートナー ネットワークと共同で作成された値です。 |
providerName |
string |
サード パーティプロバイダーの名前。 |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
direction
方向 (アップリンクまたはダウンリンク)。
名前 | 型 | 説明 |
---|---|---|
Downlink |
string |
|
Uplink |
string |
EndPoint
宇宙船との接触中にデータを格納および取得する顧客エンドポイント。
名前 | 型 | 説明 |
---|---|---|
endPointName |
string |
終点の名前。 |
ipAddress |
string |
IP アドレス (IPv4)。 |
port |
string |
データを受信するためにリッスンする TCP ポート。 |
protocol |
UDP または TCP のいずれかのプロトコル。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
NetworkConfiguration
顧客仮想ネットワークのネットワーク構成。
名前 | 型 | 説明 |
---|---|---|
subnetId |
string |
Microsoft.Orbital/orbitalGateways に委任されたサブネットの ARM リソース識別子。 少なくともクラス C サブネットである必要があり、その中に IP を作成しないでください。 |
polarization
偏光。 例: (RHCP、LHCP)。
名前 | 型 | 説明 |
---|---|---|
LHCP |
string |
|
RHCP |
string |
|
linearHorizontal |
string |
|
linearVertical |
string |
protocol
UDP または TCP のいずれかのプロトコル。
名前 | 型 | 説明 |
---|---|---|
TCP |
string |
|
UDP |
string |
ProvisioningState
リソースの作成、削除、または変更の現在の状態。
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |