New-AzApiManagementGroup
Tworzy grupę zarządzania interfejsem API.
Składnia
New-AzApiManagementGroup
-Context <PsApiManagementContext>
[-GroupId <String>]
-Name <String>
[-Description <String>]
[-Type <PsApiManagementGroupType>]
[-ExternalId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Opis
Polecenie cmdlet New-AzApiManagementGroup tworzy grupę zarządzania interfejsem API.
Przykłady
Przykład 1. Tworzenie grupy zarządzania
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementGroup -Context $apimContext -Name "Group0001"
To polecenie tworzy grupę zarządzania.
Przykład 2
Tworzy grupę zarządzania interfejsem API. (automatycznie wygenerowane)
New-AzApiManagementGroup -Context <PsApiManagementContext> -Description 'Create Echo Api V4' -GroupId '0001' -Name 'Group0001' -Type Custom
Parametry
-Context
Określa wystąpienie obiektu PsApiManagementContext.
Typ: | PsApiManagementContext |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-DefaultProfile
Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.
Typ: | IAzureContextContainer |
Aliasy: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Description
Określa opis grupy zarządzania.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-ExternalId
W przypadku grup zewnętrznych ta właściwość zawiera identyfikator grupy od zewnętrznego dostawcy tożsamości, np. azure Active Directory aad://contoso5api.onmicrosoft.com/groups/12ad42b1-592f-4664-a77b4250-2f2e82579f4c; w przeciwnym razie wartość ma wartość null.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-GroupId
Określa identyfikator nowej grupy zarządzania.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Name
Określa nazwę grupy zarządzania.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Type
Typ grupy. Grupa niestandardowa to grupa zdefiniowana przez użytkownika. Grupa systemowa obejmuje administratorów, deweloperów i gości. Nie można utworzyć ani zaktualizować grupy systemu. Grupa zewnętrzna to grupy od zewnętrznego dostawcy tożsamości, takiego jak Azure Active Directory. Ten parametr jest opcjonalny i domyślnie zakłada się, że jest grupą niestandardową.
Typ: | Nullable<T>[PsApiManagementGroupType] |
Dopuszczalne wartości: | Custom, System, External |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
Dane wejściowe
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroupType, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]