Subscription interface
Интерфейс, представляющий подписку.
Методы
Сведения о методе
createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)
Создает или изменяет подписку указанного пользователя на указанный продукт.
function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- sid
-
string
Идентификатор сущности подписки. Сущность представляет связь между пользователем и продуктом в Управление API.
- parameters
- SubscriptionCreateParameters
Создайте параметры.
Параметры параметров.
Возвращаемое значение
Promise<SubscriptionCreateOrUpdateResponse>
delete(string, string, string, string, SubscriptionDeleteOptionalParams)
Удаляет указанную подписку.
function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- sid
-
string
Идентификатор сущности подписки. Сущность представляет связь между пользователем и продуктом в Управление API.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- options
- SubscriptionDeleteOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
get(string, string, string, SubscriptionGetOptionalParams)
Возвращает указанную сущность Подписки.
function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- sid
-
string
Идентификатор сущности подписки. Сущность представляет связь между пользователем и продуктом в Управление API.
- options
- SubscriptionGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<SubscriptionGetResponse>
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)
Возвращает версию состояния сущности (Etag) подписки apimanagement, указанной ее идентификатором.
function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- sid
-
string
Идентификатор сущности подписки. Сущность представляет связь между пользователем и продуктом в Управление API.
Параметры параметров.
Возвращаемое значение
Promise<SubscriptionGetEntityTagHeaders>
list(string, string, SubscriptionListOptionalParams)
Перечисляет все подписки экземпляра службы управления API.
function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- options
- SubscriptionListOptionalParams
Параметры параметров.
Возвращаемое значение
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)
Возвращает ключи указанной подписки.
function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- sid
-
string
Идентификатор сущности подписки. Сущность представляет связь между пользователем и продуктом в Управление API.
Параметры параметров.
Возвращаемое значение
Promise<SubscriptionListSecretsResponse>
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)
Повторно создает первичный ключ существующей подписки экземпляра службы управления API.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- sid
-
string
Идентификатор сущности подписки. Сущность представляет связь между пользователем и продуктом в Управление API.
Параметры параметров.
Возвращаемое значение
Promise<void>
regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)
Повторно создает вторичный ключ существующей подписки экземпляра службы управления API.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- sid
-
string
Идентификатор сущности подписки. Сущность представляет связь между пользователем и продуктом в Управление API.
Параметры параметров.
Возвращаемое значение
Promise<void>
update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)
Обновления сведения о подписке, указанной ее идентификатором.
function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- sid
-
string
Идентификатор сущности подписки. Сущность представляет связь между пользователем и продуктом в Управление API.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- parameters
- SubscriptionUpdateParameters
Обновление параметров.
- options
- SubscriptionUpdateOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<SubscriptionUpdateResponse>