ApiTagDescription interface
Schnittstelle, die eine ApiTagDescription darstellt.
Methoden
| create |
Erstellt oder aktualisiert eine Tagbeschreibung im Bereich der API |
| delete(string, string, string, string, string, Api |
Löscht die Tagbeschreibung aus der API |
| get(string, string, string, string, Api |
Abrufen einer Tagbeschreibung im Bereich der API |
| get |
Ruft die Entitätsstatusversion des tags ab, die durch seinen Bezeichner angegeben wird. |
| list |
Listet alle Tagbeschreibungen im Bereich der API auf. Modell ähnlich wie swagger : tagDescription ist auf API-Ebene definiert, aber Tag kann den Vorgängen zugewiesen werden. |
Details zur Methode
createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)
Erstellt oder aktualisiert eine Tagbeschreibung im Bereich der API
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, parameters: TagDescriptionCreateParameters, options?: ApiTagDescriptionCreateOrUpdateOptionalParams): Promise<ApiTagDescriptionCreateOrUpdateResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- apiId
-
string
API-Revisionsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.
- tagDescriptionId
-
string
Tagbeschreibungsbezeichner. Wird beim Erstellen von tagDescription für die API/Tag-Zuordnung verwendet. Basierend auf API- und Tagnamen.
- parameters
- TagDescriptionCreateParameters
Erstellen sie Parameter.
Die Optionsparameter.
Gibt zurück
delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)
Löscht die Tagbeschreibung aus der API
function delete(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, ifMatch: string, options?: ApiTagDescriptionDeleteOptionalParams): Promise<void>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- apiId
-
string
API-Revisionsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.
- tagDescriptionId
-
string
Tagbeschreibungsbezeichner. Wird beim Erstellen von tagDescription für die API/Tag-Zuordnung verwendet. Basierend auf API- und Tagnamen.
- ifMatch
-
string
ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.
Die Optionsparameter.
Gibt zurück
Promise<void>
get(string, string, string, string, ApiTagDescriptionGetOptionalParams)
Abrufen einer Tagbeschreibung im Bereich der API
function get(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetOptionalParams): Promise<ApiTagDescriptionGetResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- apiId
-
string
API-Revisionsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.
- tagDescriptionId
-
string
Tagbeschreibungsbezeichner. Wird beim Erstellen von tagDescription für die API/Tag-Zuordnung verwendet. Basierend auf API- und Tagnamen.
Die Optionsparameter.
Gibt zurück
Promise<ApiTagDescriptionGetResponse>
getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)
Ruft die Entitätsstatusversion des tags ab, die durch seinen Bezeichner angegeben wird.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetEntityTagOptionalParams): Promise<ApiTagDescriptionGetEntityTagHeaders>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- apiId
-
string
API-Revisionsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.
- tagDescriptionId
-
string
Tagbeschreibungsbezeichner. Wird beim Erstellen von tagDescription für die API/Tag-Zuordnung verwendet. Basierend auf API- und Tagnamen.
Die Optionsparameter.
Gibt zurück
Promise<ApiTagDescriptionGetEntityTagHeaders>
listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)
Listet alle Tagbeschreibungen im Bereich der API auf. Modell ähnlich wie swagger : tagDescription ist auf API-Ebene definiert, aber Tag kann den Vorgängen zugewiesen werden.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiTagDescriptionListByServiceOptionalParams): PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- apiId
-
string
API-Revisionsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.
Die Optionsparameter.