adding index.md files for powershell sdk docs

This commit is contained in:
darrell-thobe-sp
2025-02-07 11:55:26 -05:00
parent 7eb93a19ec
commit f79d201b73
10 changed files with 243 additions and 0 deletions

View File

@@ -0,0 +1,22 @@
---
id: v2024
title: V2024
pagination_label: V2024
sidebar_label: V2024
sidebar_position: 2
sidebar_class_name: v2024
keywords: ['v2024', 'PowerShell']
description: PowerShell SDK reference V2024.
slug: /tools/powershell/reference/v2024
tags: ['v2024']
---
Welcome to the PowerShell SDK documentation for API Version V2024. This guide provides an overview of both Methods and Models, helping you understand how to interact with the API effectively.
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

View File

@@ -0,0 +1,29 @@
---
id: methods
title: Methods
pagination_label: Methods
sidebar_label: Methods
sidebar_position: 3
sidebar_class_name: methods
keywords: ['powershell', 'PowerShell', 'sdk', 'methods']
slug: /tools/sdk/powershell/v2024/methods
tags: ['SDK', 'Software Development Kit', 'v2024', 'methods']
---
Method docs provide detailed information about each API operation (or method). They describe what the method does, its input parameters, expected return values, and any considerations to keep in mind when using it.
## Key Features
- Purpose & Overview: Explains the purpose of the method and its role in the API.
- Parameters: Describes the required input parameters, including their data types.
- Response Format: Details the expected return format or structure.
- Error Scenarios: Outlines potential errors or issues that may arise during method execution.
## Available Methods
Below you'll find a list of the core methods available in the PowerShell SDK for **v2024** endpoints:
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

View File

@@ -0,0 +1,19 @@
---
id: models
title: Models
pagination_label: Models
sidebar_label: Models
sidebar_position: 3
sidebar_class_name: models
keywords: ['powershell', 'PowerShell', 'sdk', 'models']
slug: /tools/sdk/powershell/v2024/models
tags: ['SDK', 'Software Development Kit', 'v2024', 'models']
---
The PowerShell SDK utilizes data models to structure and manage data within the API. These models provide essential details about the data, including its attributes, data types, and how these models relate to each other. Understanding these models is crucial for interacting with the API effectively.
## Key Features
- Attributes: Describes each attribute, including its name, data type, and whether it's required.
- Validation & Constraints: Highlights any rules or limitations for the attributes (e.g., formats or length limits).
- Example: Provides a sample of how the model is used in the API.