New-AzApiManagementApi
Crea una API.
Syntax
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
El cmdlet New-AzApiManagementApi crea una API de Azure API Management.
Ejemplos
Ejemplo 1: Creación de una 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"
Este comando crea una API denominada EchoApi con la dirección URL especificada.
Ejemplo 2: Creación de una API mediante la copia de todas las operaciones, etiquetas, productos y directivas de echo-api y en una 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
Este comando crea una API echoapiv3
en ApiVersionSet xmsVersionSet
y copia todas las operaciones, Etiquetas y directivas de la API echo-api
de origen . Invalida SubscriptionRequired, ServiceUrl, Path, Protocols
Ejemplo 3
Crea una API. (generado automáticamente)
New-AzApiManagementApi -ApiId '0001' -Context <PsApiManagementContext> -Name 'Echo api' -Path 'echov3' -Protocols Http -ServiceUrl 'https://contoso.com/apis/echo'
Parámetros
-ApiId
Especifica el identificador de la API que se va a crear. Si no especifica este parámetro, este cmdlet genera un identificador automáticamente.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ApiType
Tipo de API que se va a crear (http, soap, websocket, graphql). Este parámetro es opcional.
Tipo: | Nullable<T>[PsApiManagementApiType] |
valores aceptados: | Http, Soap, WebSocket, GraphQL |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ApiVersion
Versión de api de la API que se va a crear. Este parámetro es opcional.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ApiVersionDescription
Descripción de la versión de api. Este parámetro es opcional.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ApiVersionSetId
Identificador de recursos para el conjunto de versiones de API relacionado. Este parámetro es opcional.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-AuthorizationScope
Especifica el ámbito de las operaciones de OAuth. El valor predeterminado es $Null.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-AuthorizationServerId
Especifica el identificador del servidor de autorización de OAuth. El valor predeterminado es $Null. Debe especificar este parámetro si se especifica AuthorizationScope .
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-BearerTokenSendingMethod
Mecanismo del servidor de autorización openId mediante el que se pasa el token de acceso a la API. Consulte https://datatracker.ietf.org/doc/html/rfc6749#section-4. Este parámetro es opcional. El valor predeterminado es $null.
Tipo: | String[] |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ContactEmail
Dirección de correo electrónico de la persona o organización de contacto. DEBE tener el formato de una dirección de correo electrónico. Este parámetro es opcional.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ContactName
Nombre de identificación de la persona o organización de contacto. Este parámetro es opcional.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ContactUrl
Dirección URL que apunta a la información de contacto. DEBE estar en el formato de una dirección URL. Este parámetro es opcional.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Context
Especifica un objeto PsApiManagementContext .
Tipo: | PsApiManagementContext |
Position: | Named |
valor predeterminado: | None |
Requerido: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DefaultProfile
Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure.
Tipo: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
Especifica una descripción de la API web.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LicenseName
Nombre de licencia que se usa para la API. Este parámetro es opcional.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LicenseUrl
Una dirección URL a los Términos del servicio para la API. Este parámetro es opcional.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Especifica el nombre de la API web. Este es el nombre público de la API tal como aparece en los portales para desarrolladores y administradores.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-OpenIdProviderId
Identificador del servidor de autorización openId. Este parámetro es opcional. El valor predeterminado es $null. Debe especificarse si se especifica BearerTokenSendingMethods.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Path
Especifica la ruta de acceso de la API web, que es la última parte de la dirección URL pública de la API y corresponde al campo sufijo url de API web en el portal de administración. Los consumidores de API usan esta dirección URL para enviar solicitudes al servicio web y deben tener una longitud de 400 caracteres. El valor predeterminado es $Null.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ProductIds
Especifica una matriz de identificadores de producto a los que se va a agregar la nueva API.
Tipo: | String[] |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Protocols
Especifica una matriz de protocolos de API web. Los valores válidos son http, https. Estos son los protocolos web sobre los que está disponible la API. El valor predeterminado es $Null.
Tipo: | PsApiManagementSchema[] |
valores aceptados: | Http, Https, Ws, Wss |
Position: | Named |
valor predeterminado: | None |
Requerido: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ServiceUrl
Especifica la dirección URL del servicio web que expone la API. Esta dirección URL solo la usa Azure API Management y no se hace pública. La dirección URL debe tener entre 2000 caracteres y una longitud de 2000 caracteres.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SourceApiId
Identificador de API de la API de origen. Este parámetro es opcional.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SourceApiRevision
Revisión de api de la API de origen. Este parámetro es opcional.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionKeyHeaderName
Especifica el nombre del encabezado de clave de suscripción. El valor predeterminado es $Null.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionKeyQueryParamName
Especifica el nombre del parámetro de la cadena de consulta de clave de suscripción. El valor predeterminado es $Null.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionRequired
Marca para aplicar SubscriptionRequired para las solicitudes a la API. Este parámetro es opcional.
Tipo: | SwitchParameter |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TermsOfServiceUrl
Una dirección URL a los Términos del servicio para la API. Este parámetro es opcional.
Tipo: | String |
Position: | Named |
valor predeterminado: | None |
Requerido: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Entradas
String[]
Salidas
Vínculos relacionados
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de