JobCredentialsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:job_credentials> attribute.

Constructor

JobCredentialsOperations(*args, **kwargs)

Methods

create_or_update	Creates or updates a job credential.
delete	Deletes a job credential.
get	Gets a jobs credential.
list_by_agent	Gets a list of jobs credentials.

create_or_update

Creates or updates a job credential.

async create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, credential_name: str, parameters: _models.JobCredential, *, content_type: str = 'application/json', **kwargs: Any) -> _models.JobCredential

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
job_agent_name Required	str The name of the job agent. Required.
credential_name Required	str The name of the credential. Required.
parameters Required	JobCredential or IO[bytes] The requested job credential state. Is either a JobCredential type or a IO[bytes] type. Required.

Returns

Type	Description
JobCredential	JobCredential or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Deletes a job credential.

async delete(resource_group_name: str, server_name: str, job_agent_name: str, credential_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
job_agent_name Required	str The name of the job agent. Required.
credential_name Required	str The name of the credential. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a jobs credential.

async get(resource_group_name: str, server_name: str, job_agent_name: str, credential_name: str, **kwargs: Any) -> JobCredential

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
job_agent_name Required	str The name of the job agent. Required.
credential_name Required	str The name of the credential. Required.

Returns

Type	Description
JobCredential	JobCredential or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_agent

Gets a list of jobs credentials.

list_by_agent(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) -> AsyncItemPaged[JobCredential]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
job_agent_name Required	str The name of the job agent. Required.

Returns

Type	Description
AsyncItemPaged[JobCredential]	An iterator like instance of either JobCredential or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv268\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>