Поделиться через

Remove-AzApiManagementApiSchema

  • Ссылка
Модуль:
Az.ApiManagement

Удаляет схему API из API.

Синтаксис

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

Описание

Командлет Remove-AzApiManagementSchema из API.

Примеры

Пример 1. Удаление схемы API из API

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

Сценарий удаляет 2 схемы из echo-api API, если он не ссылается.

Пример 2

Сценарий удаляет схему 2 из эхо-api API, если он не ссылается. (автоматическое создание)

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

Параметры

-ApiId

Идентификатор API. Этот параметр является обязательным.

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Confirm

Запрашивает подтверждение перед запуском командлета.

Тип:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Context

Экземпляр PsApiManagementContext. Этот параметр является обязательным.

Тип:PsApiManagementContext
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для взаимодействия с Azure.

Тип:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-InputObject

Экземпляр PsApiManagementApiSchema. Этот параметр является обязательным.

Тип:PsApiManagementApiSchema
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-PassThru

Если указано, будет выполнено запись true в случае успешной операции. Этот параметр является необязательным.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ResourceId

Arm ResourceId of ApiSchema. Этот параметр является обязательным.

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-SchemaId

Идентификатор схемы API. Этот параметр является обязательным.

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-WhatIf

Показывает, что произойдет, если командлет выполняется. Командлет не выполняется.

Тип:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Входные данные

PsApiManagementContext

PsApiManagementApiSchema

String

Выходные данные

Boolean