| external help file | Module Name | online version | schema |
|---|---|---|---|
Intersight.PowerShell.dll-Help.xml |
Intersight.PowerShell |
2.0.0 |
Fill in the Synopsis
Initialize-IntersightOpenapiApiInfo [-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-ApiPathObjectIdentifier< Model.MoMoRef>][-ClassId< OpenapiApiInfo.ClassIdEnum>][-Description< string>][-DisplayLabel< string>][-Method< OpenapiApiInfo.MethodEnum>][-Name< string>][-ObjectType< OpenapiApiInfo.ObjectTypeEnum>][-Path< string>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]
Initialize cmdlet is used to instantiate the object of complex type in the Powershell session, it does not create the object on the server.
Type: System.Collections.Generic.Dictionary`2[string,object]
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseUnique identifier for the ApiMethod object that holds more information about this API.
Note :- Use Initialize-IntersightMoMoRef to create the object of complex type MoMoRef
Type: Model.MoMoRef
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.
Type: OpenapiApiInfo.ClassIdEnum
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseA detailed description of the API.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseDisplay name of the selected API endpoint.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseMethod Type of the selected API.\n* GET - Method type which indicates it is a GET API call.\n* POST - Method type which indicates it is a POST API call.\n* PUT - Method type which indicates it is a PUT API call.\n* PATCH - Method type which indicates it is a PATCH API call.\n* DELETE - Method type which indicates it is a DELETE API call.
Type: OpenapiApiInfo.MethodEnum
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseName of the selected API endpoint.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.
Type: OpenapiApiInfo.ObjectTypeEnum
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseAPI Path of the selected API endpoint.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseReturns the json payload received in response.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: FalseReturns the HTTP response with headers and content.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
PS C:\> Initialize-IntersightOpenapiApiInfo{ Add example description here }