Configuration
- Last UpdatedSep 12, 2023
- 3 minute read
Get Configuration (Edge path)
Returns an Edge System Configuration.
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Edge/Systems/{edgeSystemId}/Configuration
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string edgeSystemId
Edge System identifier used as blob name in the storage account.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | Inline | Configuration for the specified Edge System. |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 404 | ErrorResponse | Configuration not found. |
| 500 | ErrorResponse | Internal server error. |
Create Configuration (Edge path)
Creates an Edge System Configuration in the storage account. Does not save any secrets supplied as part of the edge system configuration.
Request
POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Edge/Systems/{edgeSystemId}/Configuration
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string edgeSystemId
Edge System identifier used as blob name in the storage account.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 201 | Inline | Configuration created. |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 409 | ErrorResponse | Conflict. |
| 500 | ErrorResponse | Internal server error. |
Update Configuration (Edge path)
Updates an Edge System Configuration. Does not save any secrets supplied as part of the edge system configuration.
Request
PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Edge/Systems/{edgeSystemId}/Configuration
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string edgeSystemId
Edge System identifier used as blob name in the storage account.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 204 | None | No content. |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 500 | ErrorResponse | Internal server error. |
Delete Configuration (Edge path)
Deletes an Edge System Configuration.
Request
DELETE /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Edge/Systems/{edgeSystemId}/Configuration
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string edgeSystemId
Edge System identifier used as blob name in the storage account.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 204 | None | No content. |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 404 | ErrorResponse | Configuration not found. |
| 500 | ErrorResponse | Internal server error. |
Get Configuration 1
Returns an Edge System Configuration.
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Systems/{edgeSystemId}/Configuration
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string edgeSystemId
Edge System identifier used as blob name in the storage account.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | Inline | Configuration for the specified Edge System. |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 404 | ErrorResponse | Configuration not found. |
| 500 | ErrorResponse | Internal server error. |
Create Configuration 1
Creates an Edge System Configuration in the storage account. Does not save any secrets supplied as part of the edge system configuration.
Request
POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Systems/{edgeSystemId}/Configuration
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string edgeSystemId
Edge System identifier used as blob name in the storage account.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 201 | Inline | Configuration created. |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 409 | ErrorResponse | Conflict. |
| 500 | ErrorResponse | Internal server error. |
Update Configuration 1
Updates an Edge System Configuration. Does not save any secrets supplied as part of the edge system configuration.
Request
PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Systems/{edgeSystemId}/Configuration
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string edgeSystemId
Edge System identifier used as blob name in the storage account.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 204 | None | No content. |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 500 | ErrorResponse | Internal server error. |
Delete Configuration 1
Deletes an Edge System Configuration.
Request
DELETE /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Systems/{edgeSystemId}/Configuration
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string edgeSystemId
Edge System identifier used as blob name in the storage account.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 204 | None | No content. |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 404 | ErrorResponse | Configuration not found. |
| 500 | ErrorResponse | Internal server error. |
Definitions
ErrorResponse
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| OperationId | string | true | false | None |
| Error | string | true | false | None |
| Reason | string | true | false | None |
| Resolution | string | true | false | None |
| DynamicProperties | object | false | true | None |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"DynamicProperties": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}