Skip to content

Latest commit

 

History

History
221 lines (168 loc) · 5.22 KB

Remove-AzApiManagementApiSchema.md

File metadata and controls

221 lines (168 loc) · 5.22 KB
Raw
external help file Module Name online version schema
Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml
Az.ApiManagement
2.0.0

Remove-AzApiManagementApiSchema

SYNOPSIS

Removes the API Schema from the API.

SYNTAX

ByApiSchemaId (Default)

Remove-AzApiManagementApiSchema -Context <PsApiManagementContext> -ApiId <String> -SchemaId <String>
 [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]

ByInputObject

Remove-AzApiManagementApiSchema -InputObject <PsApiManagementApiSchema> [-PassThru]
 [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]

ByResourceIdParameterSet

Remove-AzApiManagementApiSchema -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The cmdlet Remove-AzApiManagementSchema from the Api.

EXAMPLES

Example 1: Removes the Api Schema from the API

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementApiSchema -Context $apimContext -ApiId "echo-api" -SchemaId "2"

The script removes the Schema 2 from the Api echo-api if it is not referenced.

Example 2

The script removes the Schema 2 from the Api echo-api if it is not referenced. (autogenerated)

Remove-AzApiManagementApiSchema -ApiId '0001' -Context <PsApiManagementContext> -SchemaId 5cc9cf67e6ed3b1154e638bd

PARAMETERS

-ApiId

Identifier of the API. This parameter is required.

Type: System.String
Parameter Sets: ByApiSchemaId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Context

Instance of PsApiManagementContext. This parameter is required.

Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameter Sets: ByApiSchemaId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

Instance of PsApiManagementApiSchema. This parameter is required.

Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiSchema
Parameter Sets: ByInputObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PassThru

If specified will write true in case operation succeeds. This parameter is optional.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceId

Arm ResourceId of ApiSchema. This parameter is required.

Type: System.String
Parameter Sets: ByResourceIdParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SchemaId

Identifier of the API Schema. This parameter is required.

Type: System.String
Parameter Sets: ByApiSchemaId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiSchema

System.String

OUTPUTS

System.Boolean

NOTES

RELATED LINKS

Get-AzApiManagementApiSchema

New-AzApiManagementApiSchema

Set-AzApiManagementApiSchema