Udostępnij za pośrednictwem

New-AzApiManagementOperation

  • Odwołanie
Moduł:
Az.ApiManagement

Tworzy operację zarządzania interfejsem API.

Składnia

New-AzApiManagementOperation
   -Context <PsApiManagementContext>
   -ApiId <String>
   [-ApiRevision <String>]
   [-OperationId <String>]
   -Name <String>
   -Method <String>
   -UrlTemplate <String>
   [-Description <String>]
   [-TemplateParameters <PsApiManagementParameter[]>]
   [-Request <PsApiManagementRequest>]
   [-Responses <PsApiManagementResponse[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Opis

Polecenie cmdlet New-AzApiManagementOperation tworzy operację interfejsu API.

Przykłady

Przykład 1. Tworzenie operacji zarządzania interfejsem API

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementOperation -Context $apimContext -ApiId $APIId -OperationId "Operation001" -Name "Operation" -Method "GET" -UrlTemplate "/resource" -Description "Use this operation to get resource"

To polecenie tworzy operację zarządzania interfejsem API.

Przykład 2. Tworzenie operacji zarządzania interfejsem API przy użyciu szczegółów żądania i odpowiedzi

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$RID = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter
$RID.Name = "RID"
$RID.Description = "Resource identifier"
$RID.Type = "string"
$Query = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter
$Query.Name = "query"
$Query.Description = "Query string"
$Query.Type = 'string'
$Request = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRequest
$Request.Description = "Create/update resource request"
$DummyQp = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter
$DummyQp.Name = 'dummy'
$DummyQp.Type = 'string'
$DummyQp.Required = $FALSE
$Request.QueryParameters = @($DummyQp)
$Header = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter
$Header.Name = 'x-custom-header'
$Header.Type = 'string'
$Request.Headers = @($Header)
$RequestRepresentation = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRepresentation
$RequestRepresentation.ContentType = 'application/json'
$exp = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameterExample
$exp.Value = "default"
$exp.Description  = "My default request example"
$exp.ExternalValue  = "https://contoso.com"
$exp.Summary  = "default"
$RequestRepresentation.Examples = @($exp)
$Request.Representations = @($requestRepresentation)
$Response = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResponse
$Response.StatusCode = 204
New-AzApiManagementOperation -Context $apimContext -ApiId $APIId -OperationId "01234567890" -Name 'Create/update resource' -Method 'PUT' -UrlTemplate '/resource/{rid}?q={query}' -Description "Use this operation to create new or update existing resource" -TemplateParameters @($rid, $query) -Request $Request -Responses @($response)

W tym przykładzie jest tworzona operacja usługi API Management ze szczegółami żądania i odpowiedzi.

Parametry

-ApiId

Określa identyfikator operacji zarządzania interfejsem API.

Typ:String
Position:Named
wartość domyślna:None
Wymagane:True
Accept pipeline input:True
Accept wildcard characters:False

-ApiRevision

Identyfikator poprawki interfejsu API. Ten parametr jest opcjonalny. Jeśli nie zostanie określona, operacja zostanie dołączona do aktualnie aktywnej poprawki interfejsu API.

Typ:String
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:True
Accept wildcard characters:False

-Context

Określa wystąpienie obiektu PsApiManagementContext .

Typ:PsApiManagementContext
Position:Named
wartość domyślna:None
Wymagane:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Określa opis nowej operacji interfejsu API.

Typ:String
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:True
Accept wildcard characters:False

-Method

Określa metodę HTTP nowej operacji zarządzania interfejsem API.

Typ:String
Position:Named
wartość domyślna:None
Wymagane:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Określa nazwę wyświetlaną nowej operacji zarządzania interfejsem API.

Typ:String
Position:Named
wartość domyślna:None
Wymagane:True
Accept pipeline input:True
Accept wildcard characters:False

-OperationId

Określa identyfikator operacji zarządzania interfejsem API.

Typ:String
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:True
Accept wildcard characters:False

-Request

Określa szczegóły operacji zarządzania interfejsem API.

Typ:PsApiManagementRequest
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:True
Accept wildcard characters:False

-Responses

Określa tablicę możliwych odpowiedzi operacji usługi API Management.

Typ:PsApiManagementResponse[]
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:True
Accept wildcard characters:False

-TemplateParameters

Określa tablicę parametrów zdefiniowanych w parametrze UrlTemplate. Jeśli ten parametr nie zostanie określony, zostanie wygenerowana wartość domyślna na podstawie elementu UrlTemplate.

Typ:PsApiManagementParameter[]
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:True
Accept wildcard characters:False

-UrlTemplate

Określa szablon adresu URL.

Typ:String
Position:Named
wartość domyślna:None
Wymagane:True
Accept pipeline input:True
Accept wildcard characters:False

Dane wejściowe

PsApiManagementContext

String

PsApiManagementParameter[]

PsApiManagementRequest

PsApiManagementResponse[]

Dane wyjściowe

PsApiManagementOperation