Freigeben über

az apic integration create

Note

Diese Referenz ist Teil der APIC-Erweiterungserweiterung für die Azure CLI (Version 2.57.0 oder höher). Die Erweiterung wird beim ersten Ausführen einer az apic-Integration automatisch Befehl installiert. Erfahren Sie mehr über Erweiterungen.

Befehle

Name Beschreibung Typ Status
az apic integration create apim

Fügen Sie Azure APIM als API-Quelle hinzu.

 Extension GA
az apic integration create aws

Fügen Sie amazon API Gateway als API-Quelle hinzu.

 Extension GA

az apic integration create apim

Fügen Sie Azure APIM als API-Quelle hinzu.

az apic integration create apim --azure-apim
                                --integration-name
                                --resource-group
                                --service-name
                                [--import-specification {always, never, ondemand}]
                                [--msi-resource-id]
                                [--target-environment-id]
                                [--target-lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]

Beispiele

Hinzufügen von Azure APIM in derselben Ressourcengruppe wie die Azure API Center-Instanz als API-Quelle

az apic integration create apim -g contoso-resources -n contoso -i sync-from-my-apim --azure-apim myapim

Hinzufügen von Azure APIM in einer anderen Ressourcengruppe als API-Quelle

az apic integration create apim -g contoso-resources -n contoso -i sync-from-my-apim --azure-apim /subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/samplegroup/providers/Microsoft.ApiManagement/service/sampleapim

Erforderliche Parameter

--azure-apim

Der Name oder die Ressourcen-ID der Quell-APIM-Instanz.

Eigenschaft Wert
Parametergruppe: AzureApiManagementSource Arguments
--integration-name -i

Der Name der Integration.

--resource-group -g

Name der Azure API Center-Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service-name -n

Der Name des Azure API Center-Diensts.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--import-specification

Gibt an, ob die Spezifikation zusammen mit Metadaten importiert werden soll.

Eigenschaft Wert
Parametergruppe: Properties Arguments
Standardwert: always
Zulässige Werte: always, never, ondemand
--msi-resource-id

Die Ressourcen-ID der verwalteten Identität, die Zugriff auf die API-Verwaltungsinstanz hat.

Eigenschaft Wert
Parametergruppe: AzureApiManagementSource Arguments
--target-environment-id

Die Ressourcen-ID der Zielumgebung.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--target-lifecycle-stage

Die Ziellebenszyklusstufe.

Eigenschaft Wert
Parametergruppe: Properties Arguments
Zulässige Werte: deprecated, design, development, preview, production, retired, testing
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az apic integration create aws

Fügen Sie amazon API Gateway als API-Quelle hinzu.

az apic integration create aws --aws-access-key-reference
                               --aws-region-name
                               --aws-secret-access-key-reference
                               --integration-name
                               --resource-group
                               --service-name
                               [--import-specification {always, never, ondemand}]
                               [--msi-resource-id]
                               [--target-environment-id]
                               [--target-lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]

Beispiele

Hinzufügen des Amazon API-Gateways als API-Quelle

az apic integration create aws -g contoso-resources -n contoso -i sync-from-my-amazon-api-gateway -a https://{keyvaultName}.vault.azure.net/secrets/{secretName1} -s https://{keyvaultName}.vault.azure.net/secrets/{secretName2} -r us-east-2

Erforderliche Parameter

--aws-access-key-reference -a

Zugriffsschlüssel des Amazon-API-Gateways. Muss ein geheimer Azure Key Vault-Verweis sein.

Eigenschaft Wert
Parametergruppe: AmazonApiGatewaySource Arguments
--aws-region-name -r

Amazon API Gateway Region (z. B. us-east-2).

Eigenschaft Wert
Parametergruppe: AmazonApiGatewaySource Arguments
--aws-secret-access-key-reference -s

Geheimer Zugriffsschlüssel des Amazon API-Gateways. Muss ein geheimer Azure Key Vault-Verweis sein.

Eigenschaft Wert
Parametergruppe: AmazonApiGatewaySource Arguments
--integration-name -i

Der Name der Integration.

--resource-group -g

Name der Azure API Center-Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service-name -n

Der Name des Azure API Center-Diensts.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--import-specification

Gibt an, ob die Spezifikation zusammen mit Metadaten importiert werden soll.

Eigenschaft Wert
Parametergruppe: Properties Arguments
Standardwert: always
Zulässige Werte: always, never, ondemand
--msi-resource-id

Die Ressourcen-ID der verwalteten Identität, die Zugriff auf den Azure Key Vault hat.

Eigenschaft Wert
Parametergruppe: AmazonApiGatewaySource Arguments
--target-environment-id

Die Ressourcen-ID der Zielumgebung.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--target-lifecycle-stage

Die Ziellebenszyklusstufe.

Eigenschaft Wert
Parametergruppe: Properties Arguments
Zulässige Werte: deprecated, design, development, preview, production, retired, testing
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False