Configuration Template
- Last UpdatedJan 24, 2024
- 3 minute read
List Templates
Returns a list of templates.
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Templates
?skip={skip}&count={count}&orderBy={orderBy}&query={query}
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.
[optional] integer skip
Parameter representing the zero-based offset of the first template to retrieve. If unspecified, a default value of 0 is used. Value must be greater than 0.[optional] integer count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used. Value cannot be less than 1 or greater than 1000.[optional] string orderBy
Query parameter to specify sort order. Valid sort order properties are Name, Type, Version, Description. If unspecified, a default value of 'name asc' is used.[optional] string query
Query parameter to specify filter. Valid filter properties are Name, Type, Version, Description.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | ConfigurationTemplate[] | List of templates. |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 500 | ErrorResponse | Internal server error. |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | Total-Count | integer | The total number of templates. |
Example response body
200 Response (ConfigurationTemplate[])
[
{
"Id": "string",
"Name": "string",
"Type": "string",
"Version": "string",
"Description": "string",
"CreatedDate": "2019-08-24T14:15:22Z",
"CreatedBy": "string",
"ModifiedDate": "2019-08-24T14:15:22Z",
"ModifiedBy": "string"
}
]
Create Template
Creates a template.
Request
POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Templates
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.
Request Body
Template data to store.
{
"Name": "string",
"Type": "string",
"Version": "string",
"Description": "string",
"Configuration": "string"
}
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. |
Get Template
Returns a configuration template.
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Templates/{templateId}
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string templateId
Configuration template identifier used as blob name in the storage account.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | Inline | Template |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 404 | ErrorResponse | Template not found. |
| 500 | ErrorResponse | Internal server error. |
Update Template
Updates a template.
Request
PATCH /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Templates/{templateId}
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string templateId
Template identifier.
Request Body
Template.
{
"Name": "string",
"Type": "string",
"Version": "string",
"Description": "string"
}
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 Template
Deletes a template.
Request
DELETE /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Templates/{templateId}
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string templateId
Template identifier.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 204 | None | No content. |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 404 | ErrorResponse | Template not found. |
| 500 | ErrorResponse | Internal server error. |
Get Template Configuration
Returns a template's configuration.
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Templates/{templateId}/Configuration
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string templateId
Configuration template identifier used as blob name in the storage account.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | Inline | Configuration for the specified template. |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 404 | ErrorResponse | Configuration not found. |
| 500 | ErrorResponse | Internal server error. |
Update Template Configuration
Updates a template configuration.
Request
PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Templates/{templateId}/Configuration
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string templateId
Template 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. |
Definitions
ConfigurationTemplate
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Id | string | false | true | None |
| Name | string | false | true | None |
| Type | string | false | true | None |
| Version | string | false | true | None |
| Description | string | false | true | None |
| CreatedDate | date-time | false | false | None |
| CreatedBy | string | false | true | None |
| ModifiedDate | date-time | false | true | None |
| ModifiedBy | string | false | true | None |
{
"Id": "string",
"Name": "string",
"Type": "string",
"Version": "string",
"Description": "string",
"CreatedDate": "2019-08-24T14:15:22Z",
"CreatedBy": "string",
"ModifiedDate": "2019-08-24T14:15:22Z",
"ModifiedBy": "string"
}
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
}
CreateTemplate
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Name | string | true | false | None |
| Type | string | true | false | None |
| Version | string | true | false | None |
| Description | string | false | true | None |
| Configuration | string | false | true | None |
{
"Name": "string",
"Type": "string",
"Version": "string",
"Description": "string",
"Configuration": "string"
}
UpdateTemplate
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Name | string | false | true | None |
| Type | string | false | true | None |
| Version | string | false | true | None |
| Description | string | false | true | None |
{
"Name": "string",
"Type": "string",
"Version": "string",
"Description": "string"
}