REST Resource: customers.deployments
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Deployment
| JSON representation |
{
"name": string,
"displayName": string,
"sasUserIds": [
string
],
"frns": [
string
]
} |
| Fields |
name |
string
Output only. Resource name.
|
displayName |
string
The deployment's display name.
|
sasUserIds[] |
string
User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.
|
frns[] |
string
Output only. The FCC Registration Numbers (FRNs) copied from its direct parent.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-12-05 UTC.
[null,null,["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eThis document provides information on the Deployment resource within the Spectrum Access System.\u003c/p\u003e\n"],["\u003cp\u003eA Deployment is represented by properties like name, display name, SAS user IDs, and FRNs (FCC Registration Numbers).\u003c/p\u003e\n"],["\u003cp\u003eKey methods to manage Deployments include creation, deletion, retrieval, listing, moving, and patching.\u003c/p\u003e\n"],["\u003cp\u003eEach deployment should be uniquely identified by a user ID associated with its devices.\u003c/p\u003e\n"],["\u003cp\u003eFRNs linked to a deployment are inherited from its parent node or customer in the hierarchy.\u003c/p\u003e\n"]]],["Deployments, represented in JSON, contain a `name`, `displayName`, `sasUserIds`, and `frns`. Key actions include creating, deleting, retrieving (get), listing, moving, and updating (patch) deployments. `sasUserIds` are unique user IDs associated with devices. `frns` are FCC Registration Numbers copied from a parent. The `name` and `frns` fields are output-only. Actions allow for managing deployments and their relationship with other nodes or customers.\n"],null,["# REST Resource: customers.deployments\n\n- [Resource: Deployment](#Deployment)\n - [JSON representation](#Deployment.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Deployment\n--------------------\n\nThe Deployment.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"displayName\": string, \"sasUserIds\": [ string ], \"frns\": [ string ] } ``` |\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name. |\n| `displayName` | `string` The deployment's display name. |\n| `sasUserIds[]` | `string` User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. |\n| `frns[]` | `string` Output only. The FCC Registration Numbers (FRNs) copied from its direct parent. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### [create](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments/create) | Creates a new [deployment](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments#Deployment). |\n| ### [delete](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments/delete) | Deletes a [deployment](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments#Deployment). |\n| ### [get](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments/get) | Returns a requested [deployment](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments#Deployment). |\n| ### [list](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments/list) | Lists [deployments](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments#Deployment). |\n| ### [move](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments/move) | Moves a [deployment](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments#Deployment) under another [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node) or [customer](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer). |\n| ### [patch](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments/patch) | Updates an existing [deployment](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments#Deployment). |"]]