ApiSchema interface

Pakket:

@azure/arm-apimanagement

Interface die een ApiSchema vertegenwoordigt.

Methoden

beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)	Hiermee wordt de schemaconfiguratie voor de API gemaakt of bijgewerkt.
beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)	Hiermee wordt de schemaconfiguratie voor de API gemaakt of bijgewerkt.
delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)	Hiermee verwijdert u de schemaconfiguratie op de API.
get(string, string, string, string, ApiSchemaGetOptionalParams)	Haal de schemaconfiguratie op API-niveau op.
getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)	Hiermee haalt u de versie van de entiteitsstatus (Etag) op van het schema dat is opgegeven door de id.
listByApi(string, string, string, ApiSchemaListByApiOptionalParams)	Haal de schemaconfiguratie op API-niveau op.

Methodedetails

beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)

Hiermee wordt de schemaconfiguratie voor de API gemaakt of bijgewerkt.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management service.

apiId

string

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

schemaId

string

Schema-id-id. Moet uniek zijn in het huidige API Management service-exemplaar.

parameters

SchemaContract

De toe te passen schema-inhoud.

options

ApiSchemaCreateOrUpdateOptionalParams

De optiesparameters.

Retouren

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)

Hiermee wordt de schemaconfiguratie voor de API gemaakt of bijgewerkt.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<ApiSchemaCreateOrUpdateResponse>

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management service.

apiId

string

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

schemaId

string

Schema-id-id. Moet uniek zijn in het huidige API Management service-exemplaar.

parameters

SchemaContract

De toe te passen schema-inhoud.

options

ApiSchemaCreateOrUpdateOptionalParams

De optiesparameters.

Retouren

Promise<ApiSchemaCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)

Hiermee verwijdert u de schemaconfiguratie op de API.

function delete(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, ifMatch: string, options?: ApiSchemaDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management service.

apiId

string

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

schemaId

string

Schema-id-id. Moet uniek zijn in het huidige API Management service-exemplaar.

ifMatch

string

ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit de headerreactie van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.

options

ApiSchemaDeleteOptionalParams

De optiesparameters.

Retouren

Promise<void>

get(string, string, string, string, ApiSchemaGetOptionalParams)

Haal de schemaconfiguratie op API-niveau op.

function get(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetOptionalParams): Promise<ApiSchemaGetResponse>

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management service.

apiId

string

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

schemaId

string

Schema-id-id. Moet uniek zijn in het huidige API Management service-exemplaar.

options

ApiSchemaGetOptionalParams

De optiesparameters.

Retouren

Promise<ApiSchemaGetResponse>

getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)

Hiermee haalt u de versie van de entiteitsstatus (Etag) op van het schema dat is opgegeven door de id.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetEntityTagOptionalParams): Promise<ApiSchemaGetEntityTagHeaders>

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management service.

apiId

string

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

schemaId

string

Schema-id-id. Moet uniek zijn in het huidige API Management service-exemplaar.

options

ApiSchemaGetEntityTagOptionalParams

De optiesparameters.

Retouren

Promise<ApiSchemaGetEntityTagHeaders>

listByApi(string, string, string, ApiSchemaListByApiOptionalParams)

Haal de schemaconfiguratie op API-niveau op.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management service.

apiId

string

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

options

ApiSchemaListByApiOptionalParams

De optiesparameters.

Retouren

PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>