REST Resource: nodes.deployments
Stay organized with collections
Save and categorize content based on your preferences.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eA Deployment is a resource that represents a group of devices and is associated with a unique user ID.\u003c/p\u003e\n"],["\u003cp\u003eIt includes properties like name, display name, SAS user IDs, and FCC Registration Numbers (FRNs).\u003c/p\u003e\n"],["\u003cp\u003eYou can manage Deployments using methods like delete, get, list, move, and patch to create, retrieve, update, or delete them.\u003c/p\u003e\n"],["\u003cp\u003eDeployments can be associated with nodes or customers for organizational purposes.\u003c/p\u003e\n"]]],["Deployments, represented in JSON, include fields like `name`, `displayName`, `sasUserIds`, and `frns`. Key actions involve managing deployments through methods: `delete`, `get`, `list`, `move`, and `patch`. Each deployment is associated with a unique user ID (`sasUserIds`). The `frns` are copied from the parent. The `move` action allows relocation under a different node or customer. The `patch` method facilitates updates. The `name` and `frns` are read-only fields.\n"],null,["# REST Resource: nodes.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| ### [delete](/spectrum-access-system/reference/rest/v1alpha1/nodes.deployments/delete) | Deletes a [deployment](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments#Deployment). |\n| ### [get](/spectrum-access-system/reference/rest/v1alpha1/nodes.deployments/get) | Returns a requested [deployment](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments#Deployment). |\n| ### [list](/spectrum-access-system/reference/rest/v1alpha1/nodes.deployments/list) | Lists [deployments](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments#Deployment). |\n| ### [move](/spectrum-access-system/reference/rest/v1alpha1/nodes.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/nodes.deployments/patch) | Updates an existing [deployment](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments#Deployment). |"]]
