az orbital contact-profile
Note
This reference is part of the orbital extension for the Azure CLI (version 2.39.0 or higher). The extension will automatically install the first time you run an az orbital contact-profile command. Learn more about extensions.
Contact profile is a reusable contact configuration.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az orbital contact-profile create |
Create a contact profile. |
Extension | GA |
| az orbital contact-profile delete |
Delete a specified contact profile resource. |
Extension | GA |
| az orbital contact-profile list |
List contact profiles. |
Extension | GA |
| az orbital contact-profile show |
Get the specified contact Profile in a specified resource group. |
Extension | GA |
| az orbital contact-profile update |
Update contact profile. |
Extension | GA |
| az orbital contact-profile wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az orbital contact-profile create
Create a contact profile.
az orbital contact-profile create --contact-profile-name
--resource-group
[--auto-tracking {disabled, sBand, xBand}]
[--event-hub-uri]
[--links]
[--location]
[--min-elevation]
[--min-viable-duration]
[--network-configuration]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--tags]Examples
Create a Contact Profile
az orbital contact-profile create --resource-group <resource-group> --name <contact-profile-name> --location "westus2" --auto-tracking-configuration "disabled" --event-hub-uri <event-hub-resource-identifier> --network-configuration "{subnet-id:<subnet-id>}" --links "[{name:Link1,polarization:RHCP,direction:Downlink,channels:[{name:channel1,center-frequency-m-hz:8160,bandwidth-m-hz:15,end-point:{end-point-name:AQUA_directplayback,ip-address:10.0.0.4,port:50000,protocol:TCP}}]}]"Required Parameters
Contact Profile name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Auto-tracking configuration.
ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital Resource Provider the rights to send telemetry into the hub.
Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Minimum viable elevation for the contact in decimal degrees. Used for listing the available contacts with a spacecraft at a given ground station.
Minimum viable contact duration in ISO 8601 format. Used for listing the available contacts with a spacecraft at a given ground station.
Network configuration of customer virtual network. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az orbital contact-profile delete
Delete a specified contact profile resource.
az orbital contact-profile delete [--contact-profile-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]Examples
Delete Contact Profile
az orbital contact-profile delete -g <resource-group> -n <contact-profile-name>Optional Parameters
Contact Profile name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az orbital contact-profile list
List contact profiles.
az orbital contact-profile list [--resource-group]
[--skiptoken]Examples
List Contact Profiles by subscription
az orbital contact-profile listList Contact Profiles by resource group
az orbital contact-profile list -g <resource-group>Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous list operation call returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az orbital contact-profile show
Get the specified contact Profile in a specified resource group.
az orbital contact-profile show [--contact-profile-name]
[--ids]
[--resource-group]
[--subscription]Examples
Get Contact Profile
az orbital contact-profile show -g <resource-group> --name <contact-profile-name>Optional Parameters
Contact Profile name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az orbital contact-profile update
Update contact profile.
az orbital contact-profile update [--add]
[--auto-tracking {disabled, sBand, xBand}]
[--contact-profile-name]
[--event-hub-uri]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--links]
[--location]
[--min-elevation]
[--min-viable-duration]
[--network-configuration]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]Examples
Update Contact Profile tags
az orbital contact-profile update --name <contact-profile-name> --resource-group <resource-group> --tags "{tag1:value1,tag2:value2}"Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
Auto-tracking configuration.
Contact Profile name.
ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital Resource Provider the rights to send telemetry into the hub.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The geo-location where the resource lives.
Minimum viable elevation for the contact in decimal degrees. Used for listing the available contacts with a spacecraft at a given ground station.
Minimum viable contact duration in ISO 8601 format. Used for listing the available contacts with a spacecraft at a given ground station.
Network configuration of customer virtual network. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az orbital contact-profile wait
Place the CLI in a waiting state until a condition is met.
az orbital contact-profile wait [--contact-profile-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Contact Profile name.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for