ApiRelease interface
Rozhraní představující ApiRelease.
Metody
create |
Vytvoří novou verzi pro rozhraní API. |
delete(string, string, string, string, string, Api |
Odstraní zadanou verzi v rozhraní API. |
get(string, string, string, string, Api |
Vrátí podrobnosti o vydané verzi rozhraní API. |
get |
Vrátí etag vydané verze rozhraní API. |
list |
Zobrazí seznam všech verzí rozhraní API. Vydání rozhraní API se vytvoří při aktuální revizi rozhraní API. Vydané verze se také používají k vrácení zpět k předchozím revizím. Výsledky budou stránkovány a mohou být omezeny parametry $top a $skip. |
update(string, string, string, string, string, Api |
Aktualizace podrobnosti o vydání rozhraní API určeném jeho identifikátorem. |
Podrobnosti metody
createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)
Vytvoří novou verzi pro rozhraní API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: ApiReleaseCreateOrUpdateOptionalParams): Promise<ApiReleaseCreateOrUpdateResponse>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
- releaseId
-
string
Identifikátor verze v rámci rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
- parameters
- ApiReleaseContract
Vytvořte parametry.
Parametry možností
Návraty
Promise<ApiReleaseCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)
Odstraní zadanou verzi v rozhraní API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, options?: ApiReleaseDeleteOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
- releaseId
-
string
Identifikátor verze v rámci rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
- ifMatch
-
string
Značka ETag entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET nebo by měla být * pro bezpodmínečnou aktualizaci.
- options
- ApiReleaseDeleteOptionalParams
Parametry možností
Návraty
Promise<void>
get(string, string, string, string, ApiReleaseGetOptionalParams)
Vrátí podrobnosti o vydané verzi rozhraní API.
function get(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetOptionalParams): Promise<ApiReleaseGetResponse>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
- releaseId
-
string
Identifikátor verze v rámci rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
- options
- ApiReleaseGetOptionalParams
Parametry možností
Návraty
Promise<ApiReleaseGetResponse>
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)
Vrátí etag vydané verze rozhraní API.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetEntityTagOptionalParams): Promise<ApiReleaseGetEntityTagHeaders>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
- releaseId
-
string
Identifikátor verze v rámci rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
Parametry možností
Návraty
Promise<ApiReleaseGetEntityTagHeaders>
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)
Zobrazí seznam všech verzí rozhraní API. Vydání rozhraní API se vytvoří při aktuální revizi rozhraní API. Vydané verze se také používají k vrácení zpět k předchozím revizím. Výsledky budou stránkovány a mohou být omezeny parametry $top a $skip.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiReleaseListByServiceOptionalParams): PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
Parametry možností
Návraty
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)
Aktualizace podrobnosti o vydání rozhraní API určeném jeho identifikátorem.
function update(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: ApiReleaseUpdateOptionalParams): Promise<ApiReleaseUpdateResponse>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
- releaseId
-
string
Identifikátor verze v rámci rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
- ifMatch
-
string
Značka ETag entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET nebo by měla být * pro bezpodmínečnou aktualizaci.
- parameters
- ApiReleaseContract
Parametry aktualizace verze rozhraní API
- options
- ApiReleaseUpdateOptionalParams
Parametry možností
Návraty
Promise<ApiReleaseUpdateResponse>