Compartilhar via

New-AzApiManagementApi

  • Referência
Módulo:
Az.ApiManagement

Cria uma API.

Sintaxe

New-AzApiManagementApi
   -Context <PsApiManagementContext>
   [-ApiId <String>]
   -Name <String>
   [-Description <String>]
   -ServiceUrl <String>
   -Path <String>
   -Protocols <PsApiManagementSchema[]>
   [-AuthorizationServerId <String>]
   [-AuthorizationScope <String>]
   [-OpenIdProviderId <String>]
   [-BearerTokenSendingMethod <String[]>]
   [-SubscriptionKeyHeaderName <String>]
   [-SubscriptionKeyQueryParamName <String>]
   [-ProductIds <String[]>]
   [-SubscriptionRequired]
   [-ApiVersionDescription <String>]
   [-ApiVersionSetId <String>]
   [-ApiVersion <String>]
   [-SourceApiId <String>]
   [-SourceApiRevision <String>]
   [-ApiType <PsApiManagementApiType>]
   [-TermsOfServiceUrl <String>]
   [-ContactName <String>]
   [-ContactUrl <String>]
   [-ContactEmail <String>]
   [-LicenseName <String>]
   [-LicenseUrl <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

O cmdlet New-AzApiManagementApi cria uma API de Gerenciamento de API do Azure.

Exemplos

Exemplo 1: Criar uma API

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementApi -Context $ApiMgmtContext -Name "Echo api" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @("http", "https") -Path "testapi"

Esse comando cria uma API chamada EchoApi com a URL especificada.

Exemplo 2: criar uma API copiando todas as operações, marcas, produtos e políticas da echo-api e para um ApiVersionSet

$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso
$versionSet = Get-AzApiManagementApiVersionSet -Context $context -ApiVersionSetId "xmsVersionSet"
New-AzApiManagementApi -Context $context -Name "echoapiv4" -Description "Create Echo Api V4" -SubscriptionRequired -ServiceUrl "https://echoapi.cloudapp.net/v4" -Path "echov3" -Protocols @("http", "https") -ApiVersionSetId $versionSet.ApiVersionSetId -SourceApiId "echo-api" -ApiVersion "v4"

ApiId                         : 691b7d410125414a929c108541c60e06
Name                          : echoapiv4
Description                   : Create Echo Api V4
ServiceUrl                    : https://echoapi.cloudapp.net/v4
Path                          : echov3
ApiType                       : http
Protocols                     : {Http, Https}
AuthorizationServerId         :
AuthorizationScope            :
OpenidProviderId              :
BearerTokenSendingMethod      : {}
SubscriptionKeyHeaderName     : Ocp-Apim-Subscription-Key
SubscriptionKeyQueryParamName : subscription-key
ApiRevision                   : 1
ApiVersion                    : v4
IsCurrent                     : True
IsOnline                      : False
SubscriptionRequired          : True
ApiRevisionDescription        :
ApiVersionSetDescription      :
ApiVersionSetId               : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apiVersionSets/xmsVersionSet
Id                            : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apis/691b7d410125414a929c108541c60e06
ResourceGroupName             : Api-Default-West-US
ServiceName                   : contoso

Esse comando cria um echoapiv3 de API no ApiVersionSet xmsVersionSet e copia todas as operações, marcas e políticas da API de origem echo-api. Ele substitui subscriptionRequired, ServiceUrl, Path, Protocols

Exemplo 3

Cria uma API. (gerado automaticamente)

New-AzApiManagementApi -ApiId '0001' -Context <PsApiManagementContext> -Name 'Echo api' -Path 'echov3' -Protocols Http -ServiceUrl 'https://contoso.com/apis/echo'

Parâmetros

-ApiId

Especifica a ID da API a ser criada. Se você não especificar esse parâmetro, esse cmdlet gerará uma ID para você.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ApiType

Tipo de API a ser criada (http, sabão, websocket, graphql). Esse parâmetro é opcional.

Tipo:Nullable<T>[PsApiManagementApiType]
Valores aceitos:Http, Soap, WebSocket, GraphQL
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ApiVersion

Versão da API a ser criada. Esse parâmetro é opcional.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ApiVersionDescription

Descrição da versão da API. Esse parâmetro é opcional.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ApiVersionSetId

Um identificador de recurso para o conjunto de versões da API relacionada. Esse parâmetro é opcional.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-AuthorizationScope

Especifica o escopo de operações OAuth. O valor padrão é $Null.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-AuthorizationServerId

Especifica a ID do servidor de autorização OAuth. O valor padrão é $Null. Você deve especificar esse parâmetro se AuthorizationScope for especificado.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-BearerTokenSendingMethod

Mecanismo de servidor de autorização OpenId pelo qual o token de acesso é passado para a API. Consulte https://datatracker.ietf.org/doc/html/rfc6749#section-4. Esse parâmetro é opcional. O valor padrão é $null.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ContactEmail

O endereço de email da pessoa de contato/organização. DEVE estar no formato de um endereço de email. Esse parâmetro é opcional.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ContactName

O nome de identificação da pessoa de contato/organização. Esse parâmetro é opcional.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ContactUrl

A URL que aponta para as informações de contato. DEVE estar no formato de uma URL. Esse parâmetro é opcional.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Context

Especifica um objeto PsApiManagementContext .

Tipo:PsApiManagementContext
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Description

Especifica uma descrição para a API Web.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-LicenseName

O nome da licença usado para a API. Esse parâmetro é opcional.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-LicenseUrl

Uma URL para os Termos de Serviço da API. Esse parâmetro é opcional.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Name

Especifica o nome da API Web. Esse é o nome público da API como ela aparece nos portais de desenvolvedor e administrador.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-OpenIdProviderId

Identificador do servidor de autorização OpenId. Esse parâmetro é opcional. O valor padrão é $null. Deve ser especificado se BearerTokenSendingMethods for especificado.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Path

Especifica o caminho da API Web, que é a última parte da URL pública da API e corresponde ao campo sufixo de URL da API Web no portal de administração. Essa URL é usada pelos consumidores de API para enviar solicitações para o serviço Web e deve ter de um a 400 caracteres. O valor padrão é $Null.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ProductIds

Especifica uma matriz de IDs de produto à qual adicionar a nova API.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Protocols

Especifica uma matriz de protocolos de API Web. Os valores válidos são http, https. Estes são os protocolos Web sobre os quais a API é disponibilizada. O valor padrão é $Null.

Tipo:PsApiManagementSchema[]
Valores aceitos:Http, Https, Ws, Wss
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ServiceUrl

Especifica a URL do serviço Web que expõe a API. Essa URL é usada apenas pelo Gerenciamento de API do Azure e não é tornada pública. A URL deve ter de um a 2.000 caracteres.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-SourceApiId

Identificador de API da API de origem. Esse parâmetro é opcional.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-SourceApiRevision

Revisão de API da API de origem. Esse parâmetro é opcional.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-SubscriptionKeyHeaderName

Especifica o nome do cabeçalho da chave de assinatura. O valor padrão é $Null.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-SubscriptionKeyQueryParamName

Especifica o nome do parâmetro da cadeia de caracteres de consulta de chave de assinatura. O valor padrão é $Null.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-SubscriptionRequired

Sinalizar para impor SubscriptionRequired para solicitações à API. Esse parâmetro é opcional.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-TermsOfServiceUrl

Uma URL para os Termos de Serviço da API. Esse parâmetro é opcional.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

Entradas

PsApiManagementContext

String

PsApiManagementSchema[]

String[]

Saídas

PsApiManagementApi