New-AzApiManagementOperation
Cria uma operação de gerenciamento de API.
Sintaxe
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>] Description
O cmdlet New-AzApiManagementOperation cria uma operação de API.
Exemplos
Exemplo 1: Criar uma operação de gerenciamento de 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"Este comando cria uma operação de gerenciamento de API.
Exemplo 2: Criar uma operação de gerenciamento de API com detalhes de solicitação e resposta
$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)Este exemplo cria uma operação de gerenciamento de API com detalhes de solicitação e resposta.
Parâmetros
-ApiId
Especifica o identificador da operação de gerenciamento de API.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | True |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-ApiRevision
Identificador da revisão da API. Este parâmetro é opcional. Se não for especificado, a operação será anexada à revisão da api atualmente ativa.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-Context
Especifica a instância do objeto PsApiManagementContext .
| Tipo: | PsApiManagementContext |
| Position: | Named |
| Default value: | None |
| Necessário: | True |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | 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 |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-Description
Especifica a descrição da nova operação da API.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-Method
Especifica o método HTTP da nova operação de gerenciamento de API.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | True |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-Name
Especifica o nome para exibição da nova operação de gerenciamento de API.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | True |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-OperationId
Especifica o identificador da operação de gerenciamento de API.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-Request
Especifica os detalhes da operação de gerenciamento de API.
| Tipo: | PsApiManagementRequest |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-Responses
Especifica uma matriz de possíveis respostas de operação de gerenciamento de API.
| Tipo: | PsApiManagementResponse[] |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-TemplateParameters
Especifica uma matriz de parâmetros definidos no parâmetro UrlTemplate. Se você não especificar esse parâmetro, um valor padrão será gerado com base no UrlTemplate.
| Tipo: | PsApiManagementParameter[] |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-UrlTemplate
Especifica o modelo de URL.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | True |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |