All Downloads are FREE. Search and download functionalities are using the official Maven repository.

powershell.api_doc.mustache Maven / Gradle / Ivy

There is a newer version: 7.9.0
Show newest version
# {{packageName}}.{{#lambda.backslash}}{{apiPackage}}{{/lambda.backslash}}.{{classname}}{{#description}}
{{.}}{{/description}}

All URIs are relative to *{{{basePath}}}*

Method | HTTP request | Description
------------- | ------------- | -------------
{{#operations}}{{#operation}}[**{{vendorExtensions.x-powershell-method-name}}**]({{classname}}.md#{{vendorExtensions.x-powershell-method-name-lowercase}}) | **{{httpMethod}}** {{path}} | {{summary}}
{{/operation}}{{/operations}}

{{#operations}}
{{#operation}}

# **{{{vendorExtensions.x-powershell-method-name}}}**
> {{{returnType}}}{{^returnType}}void{{/returnType}} {{{vendorExtensions.x-powershell-method-name}}}
{{#allParams}} >         [-{{paramName}}] <{{{vendorExtensions.x-powershell-data-type}}}>
{{/allParams}} {{{summary}}}{{#notes}} {{{.}}}{{/notes}} ### Example ```powershell {{#hasAuthMethods}} # general setting of the PowerShell module, e.g. base URL, authentication, etc $Configuration = Get-Configuration {{#authMethods}} {{#isBasicBasic}} # Configure HTTP basic authorization: {{{name}}} $Configuration.Username = "YOUR_USERNAME" $Configuration.Password = "YOUR_PASSWORD" {{/isBasicBasic}} {{#isApiKey}} # Configure API key authorization: {{{name}}} $Configuration.ApiKey.{{{keyParamName}}} = "YOUR_API_KEY" # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed #$Configuration.ApiKeyPrefix.{{{keyParamName}}} = "Bearer" {{/isApiKey}} {{#isOAuth}} # Configure OAuth2 access token for authorization: {{{name}}} $Configuration.AccessToken = "YOUR_ACCESS_TOKEN" {{/isOAuth}} {{#isHttpSignature}} # Configure HttpSignature for authorization :{{name}} $httpSigningParams = @{ KeyId = "xxxxxx1776876789ac747/xxxxxxx564612d31a62c01/xxxxxxxa1d7564612d31a66ee8" KeyFilePath = "C:\SecretKey.txt" HttpSigningHeader = @("(request-target)","Host","Date","Digest") HashAlgorithm = "sha256" } Set-ConfigurationHttpSigning $httpSigningParams {{/isHttpSignature}} {{/authMethods}} {{/hasAuthMethods}} {{#allParams}} {{^isArray}} {{#isModel}} {{{vendorExtensions.x-powershell-example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} {{/isModel}} {{^isModel}} ${{paramName}} = {{{vendorExtensions.x-powershell-example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} {{/isModel}} {{/isArray}} {{#isArray}} {{#items.isModel}} {{{vendorExtensions.x-powershell-example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} {{/items.isModel}} {{^items.isModel}} ${{paramName}} = {{{vendorExtensions.x-powershell-example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} {{/items.isModel}} {{/isArray}} {{/allParams}} {{#summary}} # {{{.}}} {{/summary}} try { $Result = {{{vendorExtensions.x-powershell-method-name}}}{{#allParams}} -{{paramName}} ${{paramName}}{{/allParams}} } catch { Write-Host ("Exception occurred when calling {{{vendorExtensions.x-powershell-method-name}}}: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) } ``` ### Parameters {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}} {{#allParams}} **{{paramName}}** | {{#isFile}}**{{dataType}}**{{/isFile}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**{{dataType}}**]({{#isContainer}}{{baseType}}{{/isContainer}}{{^isContainer}}{{dataType}}{{/isContainer}}.md){{/isFile}}{{/isPrimitiveType}}| {{description}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{.}}]{{/defaultValue}} {{/allParams}} ### Return type {{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md) (PSCustomObject){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}} ### Authorization {{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](../README.md#{{{name}}}){{^-last}}, {{/-last}}{{/authMethods}} ### HTTP request headers - **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}} - **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}} [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) {{/operation}} {{/operations}}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy