Partilhar via

New-AzApiManagementGroup

  • Referência
Módulo:
Az.ApiManagement

Cria um grupo de gerenciamento de API.

Sintaxe

New-AzApiManagementGroup
   -Context <PsApiManagementContext>
   [-GroupId <String>]
   -Name <String>
   [-Description <String>]
   [-Type <PsApiManagementGroupType>]
   [-ExternalId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

O cmdlet New-AzApiManagementGroup cria um grupo de gerenciamento de API.

Exemplos

Exemplo 1: Criar um grupo de gerenciamento

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementGroup -Context $apimContext -Name "Group0001"

Esse comando cria um grupo de gerenciamento.

Exemplo 2

Cria um grupo de gerenciamento de API. (gerado automaticamente)

New-AzApiManagementGroup -Context <PsApiManagementContext> -Description 'Create Echo Api V4' -GroupId '0001' -Name 'Group0001' -Type Custom

Parâmetros

-Context

Especifica a instância do 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 a descrição do grupo de gerenciamento.

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

-ExternalId

Para grupos externos, essa propriedade contém a ID do grupo do provedor de identidade externo, por exemplo, Azure Active Directory aad://contoso5api.onmicrosoft.com/groups/12ad42b1-592f-4664-a77b4250-2f2e82579f4c; caso contrário, o valor será nulo.

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

-GroupId

Especifica o identificador do novo grupo de gerenciamento.

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 do grupo de gerenciamento.

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

-Type

Tipo de grupo. O Grupo Personalizado é o Grupo Definido pelo Usuário. O Grupo de Sistemas inclui Administrador, Desenvolvedores e Convidados. Não é possível criar ou atualizar um Grupo de Sistemas. Grupo Externo são grupos do Provedor de Identidade Externo, como o Azure Active Directory. Esse parâmetro é opcional e, por padrão, considerado um Grupo Personalizado.

Tipo:Nullable<T>[PsApiManagementGroupType]
Valores aceitos:Custom, System, External
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

Entradas

PsApiManagementContext

String

Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroupType, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Saídas

PsApiManagementGroup